The example doesn’t require any markdown, doc formatting or types knowledge.
Its just:
--[[
Returns the first child of the Instance found with the given name.
(the 'Learn more' link is markdown and doc formatting, but I would just put it's contents here)
]]--
function Instance:FindFirstChild(name: string, recursive: boolean?): Instance
This feature request is just to show what you should already have when you need it. If you don’t have it already then it has no effect on you.
It doesn’t add another thing people need to do in order to have “good code”, it just makes this good practice easier to use.
Bumping this thread again, would love to have this feature. It would be amazing for collaborative projects that require other developers to access my modules without needing to open them and sift through all the code to find out what the parameters or methods do.
I really need this, and while we are at it, it would be nice to add support for tags like @deprecated, and @private or @internal which would tell the IDE to hide certain property or method from autocompletion and would throw an underline warning for the use of a method outside as it is marked private/internal.
--[[
Some outdated method that should be no longer used
@deprecated
]]
function Class:test()
end
Bumping. If not, all external IDE’s support documentations for your own things. I don’t understand what is with Roblox not allowing us doing so. I really don’t want to look at the source code 100 times just to understand what does what, I want straight and clear answer right in the middle of writing a method or constructor function or anything like it.
Roblox please consider this feature as it would definitely be a quality of life improvement for us scripters. I find myself writing little comments next to my methods in modules so that I have a sense of understanding about the function when I need to use it later on during development.
However, I’m still required to open the modules to find the specific method so I can read the comments. It would be extremely helpful to display these comments when accessing the methods from other scripts which allows for a smoother workflow.
Scripters please reply to this topic and like it in hopes to get the attention of an employee and hopefully get a response. Every reply counts!
Bumping this from a google search on how to do this in studio, I’m shocked its not a built in feature and sad to see its been requested for years with nothing happening!
This is genuinely amazing and anyone who spends more than 5 minutes in studio doing code will all agree this is needed yesterday
However the one big reason this hasn’t been done is that there are so many ways to handle this (as shown by everyone putting down suggestions from already existing solutions, not mentioning the wide variety of ways to implement it that haven’t been suggested already)
I do hope this gets implemented though as it would certainly help my life out a lot across the board.
This would be so useful. I really hope Roblox mods see this. I can’t believe this topic has been unnoticed for 6 whole years! Maybe tagging one of their names using the @ sign will work.
this is actually in the works! I saw someone posting about a fast flag that roblox added about a month ago. I don’t recall what the fast flag is called, nor what the original post is called.
Bump, Ive made my own custom event creator module and it has the ability to autofill function parameters for you, but Id love for the ability to add Intellisense documentation to make it even more similar to Roblox’s own events.
