Ferrum Marketplace

Doc Helpers

Vyloxi ✔ · ⬇ 0 installs · Tools

Write the doc comment for a function (JSDoc, docstring, Rustdoc, Javadoc, PHPDoc, KDoc, Go), add license headers and keep a changelog.

vyloxi.doc-helpers Download .fext

In Ferrum open Extensions in the sidebar, search for Doc Helpers and press Install. Or use Extensions: Install from File with the downloaded file.

Overview Contributions Versions (1) Reviews (0)

What it adds

Commands (4)

CommandId
Doc Helpers: Document the Function Under CursordocHelpers.documentFunction
Doc Helpers: Insert License Header...docHelpers.insertLicense
Doc Helpers: Add Changelog Entry...docHelpers.changelogEntry
Doc Helpers: Release the Unreleased Changelog Section...docHelpers.changelogRelease

Keybindings

KeysCommand
Ctrl+Alt+DdocHelpers.documentFunction

Settings

SettingDefaultWhat it does
docHelpers.license'MIT'The license offered first when you insert a header.
docHelpers.holder''The copyright holder written in license headers. If empty you are asked.

Code

Runs JavaScript from extension.js when: onCommand:docHelpers.documentFunction, onCommand:docHelpers.insertLicense, onCommand:docHelpers.changelogEntry, onCommand:docHelpers.changelogRelease.