DocuMate - VS Code Extension
|
Command | Description |
---|---|
DocuMate: Insert Class Doc (PHP) |
Generates a PHP class documentation block. |
DocuMate: Insert Method Doc (PHP) |
Generates a PHP method documentation block. |
DocuMate: Insert Property Doc (PHP) |
Generates a PHP property documentation block. |
DocuMate: Insert Class Doc (JS) |
Generates a JavaScript class documentation block. |
DocuMate: Insert Method Doc (JS) |
Generates a JavaScript method documentation block. |
DocuMate: Insert Property Doc (JS) |
Generates a JavaScript property/varaible documentation block. |
DocuMate: Insert File Info |
Inserts a file-level documentation block. |
DocuMate: Update Version Tag |
Updates the @version tag. |
Right-Click Context Menu
- Right-click on a class, method, or property, and select "DocuMate: Code Documentation", Select your choice.
Keybindings
- Default keybindings (if configured) can be customized in VS Code settings.
⚙️ Configuration
Modify settings in settings.json
to customize documentation output:
"documate.enableAuthor": true,
"documate.author": "John Doe",
"documate.enableEmail": true,
"documate.email": "johndoe@example.com",
"documate.enableVersion": true,
"documate.version": "1.0.0",
"documate.enableSince": true,
"documate.enableCopyright": true
🛠️ File Structure
📂 documate
├── 📝 package.json # Extension metadata & commands
├── 📝 extension.js # Registers commands & handles execution
├── 📂 language/
│ ├── 📝 abstract.js # Hnadler to connect all files to extension.js
├── |── 📝 config.js # Configuration settings
│ ├── 📝 CoreExtension.js # Base/Common extension logic
│ ├── 📝 PhpExtension.js # PHP-specific documentation logic
│ └── 📝 JsExtension.js # JavaScript-specific documentation logic
└── 📝 README.md # Documentation
🔥 Upcoming Features
- [ ] Support for more languages (Python, Java, C++ etc)
- [ ] Custom template configurations
📝 License
This extension is open-source and licensed under the MIT License.
💡 Contributing
Feel free to open issues and pull requests (Fork) to improve DocuMate!
🚀 Happy Coding with DocuMate! 🚀