Custom Intellisense Documentation Comments

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!

11 Likes

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!

5 Likes

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.

3 Likes

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.

3 Likes

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.

6 Likes

Bump, i started working with modules and i immediately started noticing this issue.

1 Like

Bump. Fact that this thread has been active for years speaks volumes

6 Likes

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.

1 Like

They work on this

FFlagAutocompleteUserDefinedFunctionDocumentation

I always enable this Flag.

https://devforum.roblox.com/t/what-do-you-guys-think-about-user-defined-function-documentation-a-fflag-option/2859011?u=healthykarl

4 Likes

UPDATE: They have added this!

Adding comments above a function declaration will add text documentation in autocomplete


-- This is b 
local function b()
	return 10
end
4 Likes

Oh, I had no idea this was possible.

I’ll have to try it out today. Thank you a lot for sharing!

1 Like


I have used this to create very believable RBXScriptSignals using my NetSignal module

1 Like

Can’t you just do function foo() : RBXScriptConnection