SmartDocs - Intelligent Code Documentation
Create, store, and manage inline documentation for code blocks without affecting your source code.
Features
- External Documentation Storage - Keep your documentation separate from source code
- Smart Anchor System - Automatically track code even after edits and refactoring
- Multi-Language Support - Works with C, C#, C++, Go, Java, JavaScript, Python, Rust, TypeScript, and Vue.js
- CodeLens Integration - View documentation inline in your editor
- Documentation Groups - Organize and search documentation across your entire project
- Starred Lines - Bookmark important code lines with context
- SQL Query Storage - Store and manage SQL queries alongside your code
Requirements
- VS Code 1.110.0 or higher
- A configured storage path for documentation files
Getting Started
- Right-click in any editor → "Code Docs Settings" → "Setup Path"
- Choose a directory to store your documentation (outside your workspace)
- Select code and right-click → "Add Documentation" to start documenting
Commands
- Add Documentation - Add docs to selected code
- Update Documentation - Modify existing documentation
- Delete Documentation - Remove documentation from code blocks
- Search Groups - Browse documentation across your project
- Toggle Starred Line - Bookmark important code lines
- Add SQL Query - Store SQL queries with your code
- Setup Path - Configure storage location
How It Works
SmartDocs uses an intelligent anchor system that:
- Identifies code blocks by scope and content
- Persists documentation even when code moves or changes
- Self-heals when necessary
- Supports complex code structures (functions, classes, namespaces)
Known Issues
- Vue.js support is limited to
<script> and <script setup> blocks only
- Orphaned documentation recovery UI is planned for future releases
Release Notes
0.0.1
Initial release of SmartDocs with:
- Core documentation storage and retrieval
- Multi-language code parsing with tree-sitter
- CodeLens provider for inline documentation display
- Documentation groups and search functionality
- Starred lines feature for bookmarking code
- SQL query storage support
| |
