The question is pretty simple summed up in the title. I was wondering if you could put a custom description of a function, especially for module functions. Similar to Connection:Disconnect. When typing Connection:Disconnect syntax highlighting will describe the function as “disconnect the function from the events”. Is this possible to do with custom-made functions?
At most I been able to achieve is just what variables the function takes with typechecking.
AFAIK, there is no way of putting descriptions on any value. I also want this feature but I can’t find any topics/tutorials about this. This is (probably) the best type check tutorial, although it is very long
Anyways, you will either have to put comments to know its function, or memorise the function. A good parameter type check might help you remember its function.
Yes, You can put a comment before a the function as of roblox’s latest update, you can also use stuff like strong text or codeblock for that, For example:
--[[
Comment!
This is <strong> strong text! </strong>
]]
local function Test()
end)