This extension checks for missing or obsolete documentation. It checks the module, classes, methods and functions.
I recommend using the Error Lens extension to view the warnings in this way:
📦 Install
Go to View -> Command Palette
Then enter Install Extension
Write doc-checker
Select it or press Enter to install
📝 Languages supported
Python
Google
NumPy
reST
JavaScript/TypeScript
Google Closure
JSDoc
Java
Javadoc
🚧 More under construction
⚙️ Settings
Doc Checker extension settings start with doc-checker.
Setting
Default
Description
activateOnChange
true
The extension will be activated when a file is changed.
class
true
Check that all classes have a docstring.
debounceDelay
300
Specifies the delay, in milliseconds, before the checker runs after changes are made when 'modify' mode is activated.
function
true
Check that all functions have updated docstring.
languages
["java", "javascript", "python", "typescript"]
Specify the languages for which the checker should run.
method
true
Check that all methods have updated docstring.
mode
"save"
Choose when to activate the checker. 'modify' activates on any file modification, 'save' activates on file save.
module
true
Check that all modules have a docstring.
parameter
true
Check that all functions and methods have updated parameters.
return
true
Check that all functions and methods have updated returns.
throw
true
Check that all functions and methods have updated throws.
🤝 Contributing
We welcome contributions to the Doc Checker! If you have suggestions for improvements, bug fixes, or new features, please check out our Contributing Guidelines for more details on how to get started.
Your feedback and contributions are invaluable to making this extension better for everyone. Thank you for your interest in contributing! 🙌
