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.
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.
Multi-language server and extension for vscode-based editors. Supports various Infinity Engine and Fallout syntaxes.
1 post • Page 1 of 1