DocBlockr
A Sublime Text package that simplifies writing DocBlock comments for JavaScript, PHP, CoffeeScript, and other languages.
What is DocBlockr?
DocBlockr is a Sublime Text package that automates the creation of documentation comments (DocBlocks) for multiple programming languages. It analyzes code structure to generate comment templates, infer types, and provide tag completions, significantly speeding up the documentation process. The tool helps developers maintain consistent and thorough documentation with minimal effort.
Developers using Sublime Text who write code in JavaScript, PHP, CoffeeScript, C++, or other supported languages and need to generate detailed API documentation. It's especially useful for teams adhering to JSDoc, PHPDoc, or similar documentation standards.
DocBlockr saves time by automating repetitive documentation tasks, reduces errors through intelligent type inference, and supports a wide range of languages and documentation styles. Its deep integration with Sublime Text and high configurability make it a powerful tool for maintaining clean, consistent documentation.
Overview
Simplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++
Use Cases
Best For
- Automatically generating JSDoc or PHPDoc comments for functions and methods
- Enforcing consistent documentation styles across a team or project
- Reducing manual typing when documenting large codebases
- Writing documentation for multiple programming languages in a single editor
- Inferring variable types from naming conventions like Hungarian notation
- Quickly adding inline documentation comments for variables
Not Ideal For
- Teams using modern IDEs other than Sublime Text, such as VS Code or JetBrains products
- Projects requiring documentation automation integrated into CI/CD pipelines or cloud-based tools
- Codebases heavily reliant on post-2015 language features not supported by the outdated parsers
Pros & Cons
Pros
Supports over a dozen languages including JavaScript, PHP, C++, and Rust, making it versatile for multi-language projects without switching tools.
Detects variable types from naming conventions like 'is' for booleans and allows custom notation maps, reducing manual guessing and errors.
Offers numerous settings for comment alignment, indentation, and extra tags, enabling teams to enforce consistent documentation styles.
Automatically generates templates and completions without keyboard shortcuts, streamlining the documentation workflow in Sublime Text.
Cons
Last updated in 2015, so it lacks support for newer Sublime Text versions and modern language features, risking compatibility issues.
Exclusively works in Sublime Text 2 and 3, making it irrelevant for developers using other popular editors or seeking cross-platform solutions.
Legacy settings with prefixes like 'jsdocs_' and numerous options can be confusing and time-consuming to tailor for advanced use cases.
Frequently Asked Questions
Related Projects
EmmetEmmet for Sublime Text
SublimeCodeIntel💡 Full-featured code intelligence and smart autocomplete for Sublime Text
Sidebar EnhancementsSide Bar Tools and Enhancements for Sublime Text. Files and folders.
SublimeLinterThe code linting framework for Sublime Text
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.