VScode extension adding support for IE and Fallout syntaxes.
Post Reply
User avatar
Magus
Site Admin
Posts: 413
Joined: Mon Nov 21, 2016 9:13 am
Contact:

Docstrings

Post by Magus » Mon Jan 23, 2023 9:01 am

Docstrings are JSdoc-like. A docstring is a block comment, which starts with /** instead of just /*.
It is always at least 3 lines long and must directly precede the function it describes. No blank lines inbetween.

fallout-docsring.png
fallout-docsring.png (40.28 KiB) Viewed 61 times
weidu-docstring.png
weidu-docstring.png (40.49 KiB) Viewed 61 times

It supports generic function description, as well as the following tags:
- @arg (or @param). Arg may include type and default. Types are normal Fallout and WeiDU types, with addition of "list" and "map" types, which mean simple and associative arrays, correspondingly.
- @ret (@return, returns). May include type.
- @deprecated. Should include short description why and what to use instead.

Docstring information will be added to intellisense.
weidu-docstring-hover.png
weidu-docstring-hover.png (38.18 KiB) Viewed 61 times
weidu-docstring-completion.png
weidu-docstring-completion.png (96.39 KiB) Viewed 61 times
fallout-docstring-hover.png
fallout-docstring-hover.png (69.53 KiB) Viewed 61 times
Please do not PM or email me about my mods and projects. Use forums. Also, see our talk channels.

Post Reply