I want to know if roblox has an official way to make a docstring, or if there’s a way to add formatting features like bold or italics.
-- this text shows when hovering over the function
function StateManager.New(Player : Instance)
end
This comment is wrong see solution
I belive the formatting is like this:
<bold> this is bold </bold>
<i> this is italanic</i>
<s> strike though </s>
1 Like
The formatting shows up as plain text
I don’t know about bold, but for multi-line comments you can do:
-- adds two numbers together
-- x is the first number, y is the second
local function add(x, y)
and if you want to be able to add spaces between lines, you can do:
--[[
adds two numbers together
x is the first number, y is the second
]]
local function add(x, y)
1 Like
yes, goes like this
--- `ClassName` class
-- @type ClassName
-- @name ClassName:new
-- @param p1 a `Param1`
-- @param p2 a `Param2`
-- @return a new `ClassName`
-- @usage
-- any comments```
3 Likes
So you want a special comment at runtime wdym by that? This is my first time i’ve ever heard about a “docstring”…
1 Like
A Documentation String is basically the text that explains the code or code documentation.
I was wondering if I could make some parts of the string bold to emphasize certain points, but I guess I can’t
wdym by emphasize certain points does this code feel emotions?
It would be for other people reading the documentation. I guess its not really that important now that you point it out though
Can’t you just make a ui ingame and do .MouseEnter event or whatever if ur making an ingame documentation for that stuff. Or if you want to make a custom system for more optimization and less bandswith just rescript it from scratch using OOP since this time OOP might matter if ur sending alot of data, and the mathematical formula for handling spatial queries and fork it to work based on UI and it should be good to go…
<strong>text</strong> is bold
<em>text</em> is italic
<code>text</code> makes a code block
3 Likes
Is that in Roblox Studio or is this for a webpage or something or is this like typescript i’m confused i’ve never seen this before…
its the roblox studio script editor
hhhhhhhh
Oh, so this is for the Roblox Script Editor. In that case, it may be somewhat unoptimized due to limitations in Roblox’s scripting environment rather than purely poor engineering practices. A better approach would be to write a Roblox Studio plugin instead, since plugins allow much more customization and control over tooling behavior. That would also let you optimize things properly, for example by minimizing allocations, avoiding unnecessary work per frame, and structuring data efficiently.
Using C++ or a similar native language directly for this wouldn’t really be practical. While C++ is generally much faster than Luau, Roblox does not allow native code to run inside Studio or the client for security and sandboxing reasons. Roblox itself is implemented largely in C++, but that doesn’t mean external C++ code can hook into or extend Studio directly.
Languages like Rust are also compiled and memory-efficient, but they face the same limitation: they cannot run inside Roblox or integrate at a low level with Studio. The only supported way to extend Studio is through plugins written in Luau.
External tools can exist (for example, editors or utilities written in C++, Rust, or other languages) and communicate with Roblox Studio via files, HTTP, or WebSockets, but the actual execution and editor integration still has to go through Luau and Roblox’s APIs. Because of that, performance-sensitive logic should be designed to fit Luau’s strengths rather than trying to replace it.
With careful scripting, batching work, and avoiding heavy per-frame operations, it’s still possible to achieve smooth performance (including 60+ FPS) even on low-end devices like Intel Celeron systems. also btw this is robot like because i edited it with ChatGPT because i typed it out and there was like 15 spelling mistakes…
Yep this works where did you find this at?
1 Like
probably some random devforum post i dont remember
1 Like
I think you should delete this entire GPT-speak reply since it is completely unrelated to the topic at hand.
Roblox’s IDE supports basic formatting for function documentation, as explained above.
This is what OP was looking for. There is no need to create a plugin unless they are willing to recreate studio’s IDE, or if they swapped to something like VSCode.
4 Likes
yes but why would i trust a corporate company they might steal my information i prefer to code it again from scratch and make it more optimized for all devices
also all that stuff is easy to recreate and at max takes a week and AT MAX means VERY GENEROUSLY its very easy could take like 1-2 days to make a plugin for that
[ Serious Response To Ragebait Here ]