How would I add informational text to ModuleScript funtions?

When you’re coding, if you have tips on, you might see this for some functions:
Screenshot 2024-11-02 122456
(where it says what it does, “Returns an Instance of the specified class”)

Well, I’m making a ModuleScript and am not sure how to add this for functions
Screenshot 2024-11-02 122513
So, does anyone know how to add it? I’m guessing it is not a feature, but there might be a way.

Unfortunately, Roblox does not natively support tooltips like this as far as I know.
One way you could do it to use comments like:

--[[ 
    Creates a new object with specific settings.
    @param Name: string - The name of the object.
    @param R6: boolean - Whether to use the R6 character model.
    @param BodySize: number - The size of the body.
    @return Instance - Returns a new instance configured with the provided parameters.
]]

1 Like

I have a question about that, why are you using @param?
I’m not saying it’s incorrect, I have just never used that before. Does it do something, or is it just for looks are help?

Hey, @param is just for looks. Nothing special about it.

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