js-docusaurus - Comment Linter for Visual Studio Code

Js-docusaurus is an opinionated comment linter for Javascript and Typescript projects. It enforces a consistent style for providing inline documentation for your code. This extension reminds you to document the most areas of your codebase.

. JavaScript · TypeScript

Philosophy

A proper documented application brings joy and increases the confidence of a team. However code documentation still remains one of the toughest issues to tackle today.

• Most code bases are either not properly documented or not documented at all.
• Engineers frequently complain of the stress involved in maintaining a good docs.

This extension is an attempt to ease the pain of documenting apps. It reminds you to document areas of your code that are relied on e.g documenting all exported functions. Basically, this means you don't need to document your entire codebase but only focus on documenting the most important areas.

Installation

Install through VS Code extensions. Search for js-docusaurus - comment linter

Features

Comment linter

Known Issues

This extension is still relatively new therefore there are lots of areas of code documentation that still needs work.

Changelog

See CHANGELOG for more information.

Contributing

See CONTRIBUTING for more information.