Doc Helpers
Document a function
Put the cursor on (or just above) a function and run Document the Function Under Cursor. It reads the signature and writes the comment skeleton with every parameter and the return type, ready for you to fill in:
| Language | Comment |
|---|---|
| JavaScript, TypeScript | JSDoc, or TSDoc (no types repeated) in TypeScript |
| Python | Google style docstring inside the function |
| Rust | /// with Arguments, Returns or Errors |
| Go | // Name ... |
| Java, C#, C, C++, Dart, Scala | Javadoc style |
| PHP | PHPDoc |
| Kotlin | KDoc |
It handles signatures over several lines, async, generics, default values and destructured parameters. The summary lines are left empty on purpose: it never invents a description.
License headers
Insert License Header... adds a short notice (MIT, Apache-2.0, GPL-3.0-or-later, BSD-3-Clause, ISC, MPL-2.0 or Unlicense) with your name and the year, as comments in the right syntax for the file. It goes after a shebang, <?php or XML declaration, and it asks before adding a second header. Remember to also have the full license in a LICENSE file.
Changelog
For a changelog in the Keep a Changelog format: Add Changelog Entry... puts a bullet under Unreleased in the right section (Added, Changed, Deprecated, Removed, Fixed, Security), creating the section in the standard order. Release the Unreleased Changelog Section... turns Unreleased into a version with today's date and leaves a fresh empty Unreleased on top.
No permissions needed: it edits the file you have open.