Swetch29
(Richard)
June 15, 2023, 8:03pm
#1
The title explains itself: How can I document my code auto-completion in the same way as built-in functions are implemented? For example:
Custom implementation:
Built-in function with documentation and code snippet:
I know there’s a website (https://luau-lang.org/ ) explaining Luau’s type engine, but it doesn’t seem to provide any information about implementing code auto-completion in the same way built-in functions are implemented.
1 Like
You can achieve this using ScriptEditorService . I would give you a code example, but I don’t use the service often.
You would need to make a plugin for it to work however.
1 Like
Swetch29
(Richard)
June 17, 2023, 12:09am
#3
Do you know of any existing plugin that is capable of interacting with this service?
There’s a few, (this one most notably ). There’s a feature request that I recommend supporting that advocates for this particular feature (without using a plugin or ScriptEditorService)
The Problem
As a Roblox developer, it is currently too hard to create in-depth documentation of Lua methods, modules, properties, and other entities.
The Request
For most programming languages, there are established conventions regarding code documentation, called DocBlocks. Lua does have LuaDoc , though I can not speak for its popularity. I am not actually requesting LuaDoc support in specific - literally anything will do, even if it only applies to Roblox.
Some features that I think should …
1 Like
system
(system)
Closed
July 1, 2023, 12:16am
#5
This topic was automatically closed 14 days after the last reply. New replies are no longer allowed.