Search Unity

  1. Welcome to the Unity Forums! Please take the time to read our Code of Conduct to familiarize yourself with the forum rules and how to post constructively.
  2. Unite 2023 Registrations are now LIVE! We are thrilled to announce that Unite 2023 Registration is now live and open for all!
    Dismiss Notice
New Forum User Notice Unite 2023 Registrations are now LIVE!

Feedback summaries tooltip

Discussion in 'Content Pipeline Dev Blitz Day 2023 - Q&A' started by jawasjnsdjn, Jun 7, 2023.

  1. jawasjnsdjn

    jawasjnsdjn

    Joined:
    Mar 7, 2013
    Posts:
    37
    I propose a new feature for Unity that automatically displays summaries from script as tooltips within the Editor. automatically or even just in the rightclick menu of inspector text. Instead of manually adding tooltip attributes to scripts, this feature extracts relevant descriptions from script files, streamlining asset management
     
    jawasjnsdjn, Jun 7, 2023
    #1

  2. unity_Jonny

    unity_Jonny

    Unity Technologies

    Joined:
    Feb 11, 2020
    Posts:
    19
    Yeah, that sounds like that would be useful.
    I think any comments or summaries would still need to be annotated to let whatever parses them know which bits to include, otherwise you'd get all sorts of weird stuff showing up if any old comment could get shown.

    There are some common ways of doing this in other language ecosystems, like adding triple slash '///' comments which get parsed as documentation, or maybe '//!' like in the Rust language documentation like here https://doc.rust-lang.org/src/std/thread/mod.rs.html#1-1689
     
    Last edited: Jun 8, 2023
    unity_Jonny, Jun 8, 2023
    #2

  3. unity_Jonny

    unity_Jonny

    Unity Technologies

    Joined:
    Feb 11, 2020
    Posts:
    19
    If you want to describe what you had in mind in a bit more detail, you could either submit a bug report with Feature Request in the title, or another way is to submit a feature request on th Editor roadmap here: https://unity.com/roadmap/unity-platform/editor (there's a 'Submit a new idea!' card at the top of the page.
    Submitting things in thid way helps get the feature sent to the right team quickly.
     
    unity_Jonny, Jun 8, 2023
    #3

  4. jiraphatK

    jiraphatK

    Joined:
    Sep 29, 2018
    Posts:
    251
    I think the OP meant that they want the c# summary to automatically be shown in tooltip.
    upload_2023-6-8_17-36-4.png
    right now we have to add two of them to support both.
     
    Last edited: Jun 8, 2023
    jiraphatK, Jun 8, 2023
    #4
    NotaNaN and jawasjnsdjn like this.

  5. unity_Jonny

    unity_Jonny

    Unity Technologies

    Joined:
    Feb 11, 2020
    Posts:
    19
    Oh I see, right, that make more sense :)
    Thanks for clearing that up
     
    unity_Jonny, Jun 8, 2023
    #5

  6. BrunoL_Unity

    BrunoL_Unity

    Unity Technologies

    Joined:
    Jun 6, 2022
    Posts:
    4
    Hey thanks for sharing, I'll make sure to forward this suggestion to the Product Manager for this product area.
     
    BrunoL_Unity, Jun 8, 2023
    #6
    NotaNaN and jawasjnsdjn like this.