Sublime JSDocs - 注释编写简化工具

Sublime JSDocs - 注释编写简化工具

sublime-jsdocs Simplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++ 项目地址: https://gitcode.com/gh_mirrors/su/sublime-jsdocs

项目基础介绍及编程语言

Sublime JSDocs 是一个专为 Sublime Text 2 和 3 设计的高效插件，旨在极大化地简化多语言（特别是JavaScript及相关语言）的文档注释过程。此项目采用 JavaScript 进行开发，并支持多种编程语言，包括但不限于 JavaScript（含ES6特性）、PHP、ActionScript、CoffeeScript、TypeScript、Java、Apex、Groovy、Objective-C、C、C++ 及 Rust，覆盖了广泛的编程需求。

核心功能

Sublime JSDocs 的核心在于自动智能地辅助开发者编写 DocBlock 样式的注释。它能够：

• 自动在 /** 后插入并关闭注释块，适应 CoffeeScript 时使用 ###*。
• 分析函数定义，自动生成参数、返回值等文档信息，通过简单地按 Tab 键即可在预填充的字段间导航。
• 根据变量声明智能推断数据类型，自动完成注释。
• 支持内联文档注释的快速生成与自动扩展，以及对代码风格的个性化配置。
• 提供评论美化功能，如快捷键装饰双斜线注释。
• 具备重解析与重新格式化注释的能力，帮助修复或调整已存在的注释结构。

最近更新的功能

尽管具体的更新日期需参照仓库的最新提交记录，但基于历史记录，项目的一些重要更新包括：

• 错误处理改进：例如修正了文档块重新解析时的缩进错误，提高了对解析错误的容错性。
• 配置选项增强：增加了用户定制选项，比如允许禁用特定的行为，如快速打开内联注释时的空间添加或内联评论的装饰。
• 语言支持扩展及优化：对特定语言如PHP的数组表示进行了识别优化，以及对不同语言如Apex的支持加入。

请注意，为了获取最新的更新详情，应当直接访问项目的GitHub页面查看最新的提交或版本发布说明。Sublime JSDocs持续的社区贡献和维护使其成为提升编码效率，保证代码可读性和质量的强大工具。

sublime-jsdocs Simplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++ 项目地址: https://gitcode.com/gh_mirrors/su/sublime-jsdocs