[v.22.3] SimpleComplete | All scripting plugins in 1 + more!

Essentially, there are 2 main things inside the docstrings: Tags and Attributes

These work similarly to Instance tags and attributes, tags are simply names and attributes have both a name and a value.

For example, <deprecated> is a tag, while <kind>: $Function$ is an attribute ($…$ is used to define strings)
These can be in any order inside the docstring, for example:

image

But for defining variable/table member docstrings, you need a special <docstring> tag at the start of the comment, like this:

--[[<docstring>

]]

on the top of it. This is as to not conflict with any existing comments

4 Likes