DocuMate - VS Code Extension (v1.0.2)

DocuMate is a powerful VS Code extension designed to automate and streamline code documentation for PHP and JavaScript. It generates class, method, and property documentation comments with customizable author details, versioning, and copyright information.

✨ Features

• 📌 Automatic Documentation Generation
  • Insert class, method, and property documentation for PHP and JavaScript.
  • Supports JSDoc and PHPDoc formats.
• 🎯 File-Level Documentation
  • Generate a summary block with author, version, and copyright details.
• ⚡ Version Tag Update
  • Quickly update the @version tag across files.
• 🛠️ Customizable Settings
  • Enable/disable author, email, version, and copyright details.
• 🚀 Intuitive Commands
  • Right-click or use keybindings to insert documentation snippets.

💌 Installation

1. Open VS Code.
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X).
3. Search for "DocuMate".
4. Click Install and restart VS Code if needed.

🎮 Usage

Commands

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! 🚀