Am I able to create descriptions for my functions, similar to how roblox does?

  1. What do you want to achieve? Keep it simple and clear!
    I want to add descriptions to my functions, to explain the parameters and the output.

  2. What solutions have you tried so far? Did you look for solutions on the Developer Hub?
    I found this post on the devforum, but the solution did not sound very confident in their answer. So I am curious if anyone can give me a certain answer.

This is what I am referring to:
image

I would like to create these for my own functions.

If this is not possible, do I need to wait to be ranked up in the devforum before I can suggest this?

2 Likes

Unfortunately no. There is a way, but it’s used by very advanced developers who use Rojo and VS Code. Not worth it for a new developer.

1 Like

However, Roblox does add comments above their functions to describe what the function does. It’s considered good practise in case you forget what a function does.

2 Likes

Here it is: Roblox Lua Style guide

1 Like

Where is this method? I couldn’t find it in roblox lua style guide.

2 Likes

This topic was automatically closed 14 days after the last reply. New replies are no longer allowed.