Where does the [description] for @field appear?

[imai-makoto]

Hello. I have looked at various pages related to this topic, but I am not sure, so I would like to ask a question.

Where does the [description] for @field appear?
I have written the following code.
Code completion seems to be working, but how does the TEST part show up?
I could not find it.
Does it depend on some setting?
Can someone please tell me.

---@class hoge 
---@field huga number TEST 

hoge = {} 
hoge = {huga = ...}

Finally, I am a beginner in coding.
I don't understand English, so I am using machine translation to view the page. Therefore, there may be mistakes or oversights. If so, I apologize.
Thank you very much. 🙇‍♂️🙏

[carsakiller]

Hello, and welcome! 👋🙂

@class creates a “blueprint” for an object. @field adds entries to that blueprint. The combination of the two is very helpful when using tables, as you seem to have found out.

The description you define for the field should appear when referencing that field. Here are some examples from Visual Studio Code:

More examples can be found in our wiki.

For translations, I have found simple translate to be pretty accurate and convenient.

Hopefully this helps! Good luck with your coding journey!

[imai-makoto]

Thank you so much🙏😊
I have checked the image you provided. Then I found that my code contained unnecessary line breaks. For some reason, I couldn’t notice it.
By removing that line break, I was able to confirm that the description is displayed.

Also, thank you for telling me about the great translation tool. I will try to use that tool in practice.