安装docblockr插件后，在函数上方输入/**并回车，即可自动生成结构化注释块，支持javascript、php、python等多种语言，自动识别参数并填充类型，提升代码可读性与开发效率。
在 Sublime Text 中使用 DocBlockr 插件可以快速生成函数或方法的注释块（DocBlock），提高代码可读性和开发效率。以下是具体配置和使用方法。
安装 DocBlockr 插件
确保你已安装 Package Control，然后按以下步骤操作：
-
1. 按下 Ctrl+Shift+P（Windows/Linux）或 Cmd+Shift+P（Mac）打开命令面板2. 输入 "Install Package"，选择对应选项3. 搜索 "DocBlockr" 并点击安装
使用方法：快速生成注释块
安装完成后，在函数上方输入 /** 然后按下回车，即可自动生成结构化的注释块。
示例代码（JavaScript）：/**
* [函数描述]
* @param {string} name - 参数说明
* @returns {boolean} 返回值说明
*/
function checkName(name) {
return true;
}
DocBlockr 会自动识别参数名、类型（根据语言支持情况）并填充到注释中。
支持的语言
DocBlockr 支持多种语言，包括但不限于：
-
• JavaScript• PHP• Python• Java• C++• Go
不同语言下生成的注释格式会自动适配对应规范（如 PHPDocumentor、JSDoc 等）。
常用技巧与设置
提升使用体验的小技巧：
-
• 在函数上方输入 /// 或 /** 后回车触发• 使用 Tab 键快速跳转到下一个注释字段（如 description、@param）• 修改插件设置文件可自定义作者、日期格式等信息• 支持 @author、@version、@since 等标签自动填充
基本上就这些。只要正确安装插件并掌握触发方式，就能在大多数项目中快速写出标准注释。不复杂但容易忽略细节。
