安装DocBlockr插件后,通过输入/**并回车或设置快捷键Ctrl+Alt+/,可为JavaScript、Python等函数自动生成包含参数和返回值的规范注释,提升代码可读性。

Sublime Text 本身不自带代码文档注释的自动生成功能,但通过安装插件和配置快捷方式,可以快速生成函数或类的文档注释。以下是几种实用的方法。
使用 DocBlockr 插件生成注释
DocBlockr 是 Sublime 中最常用的注释生成插件,支持多种语言(如 JavaScript、PHP、Python 等)。
- 打开 Sublime Text,按下 Ctrl+Shift+P 调出命令面板
- 输入 "Install Package" 并选择 "Package Control: Install Package"
- 等待列表加载完成后,搜索并安装 DocBlockr
- 安装完成后,在函数上方输入 /** 然后按回车,插件会自动识别函数参数并生成注释模板
配置快捷键快速生成注释
你可以为生成注释设置快捷键,提高效率。
- 进入菜单栏:Preferences → Key Bindings
- 在右侧用户键位设置中添加自定义快捷键,例如:
{ "keys": ["ctrl+alt+/"], "command": "docblockr" }
本文档主要讲述的是maven使用方法;Maven是基于项目对象模型的(pom),可以通过一小段描述信息来管理项目的构建,报告和文档的软件项目管理工具。Maven将你的注意力从昨夜基层转移到项目管理层。Maven项目已经能够知道 如何构建和捆绑代码,运行测试,生成文档并宿主项目网页。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看
保存后,将光标放在函数上方,按下快捷键即可触发注释生成。
不同语言中的使用示例
以 JavaScript 和 Python 为例:
- JavaScript 函数前输入 /** + Enter,会生成包含 @param、@return 的注释块
- Python 中对 def 函数使用同样操作,可生成符合 Google 或 NumPy 风格的 docstring(可在插件设置中调整风格)
基本上就这些。只要装好 DocBlockr,配合简单的操作就能高效写出规范的文档注释,提升代码可读性。









