Generate Documentation¶
Good documentation is valuable but tedious to write. This generates JSDoc/docstrings that actually describe what your code does — parameters, return values, edge cases — based on the implementation, not just the signature.
Automatically generate JSDoc/docstrings for functions, classes, and methods.
Usage¶
- Place your cursor in a function or select code
- Press
Ctrl+Shift+D(Cmd+Shift+Don Mac) - Documentation is inserted above the function
Supported Languages¶
- TypeScript / JavaScript
- Python
- And more — works with any language that uses doc comments
What It Generates¶
- Function/method description
- Parameter descriptions with types
- Return type documentation
- Usage examples where applicable
Configuration¶
| Setting | Default | Description |
|---|---|---|
sidekick.docModel |
auto |
Model tier — resolves to fast for quick generation |