DocBlockr,不仅仅可以自动生成注释,还可以手动编辑注释的格式。
#### 安装方法:
~~~
Cmd+Shift+P -> Install Package -> docblockr
~~~
windows是`ctrl+shift+P`;
#### 自定义配置:
~~~
Preference -> Package Settings -> DocBlockr -> Settings - User
~~~
配置成如下内容:
~~~
{
"jsdocs_extra_tags":[
"@Author Hybrid",
"@DateTime {{date}}",
"@copyright ${1:[copyright]}",
"@license ${1:[license]}",
"@version ${1:[version]}"
],
"jsdocs_function_description": false
}
~~~
效果图如下:
用过一段时间后想要编写自己的注释内容,如去掉copyright,version等注释,添加一些自己想要添加的注释,查找了很多注释格式,发现还是这种的精简:
~~~
/**
* 函数功能简述
*
* 具体描述一些细节
*
* @param {string} address 地址
* @param {array} com 商品数组
* @param {string} pay_status 支付方式
* @returns void
* @date 2016-06-12
* @author Judy
*/
~~~
所以仔细看了下参考的链接,总结如下
参考: https://github.com/spadgos/sublime-jsdocs/
- 目录
- 教程
- 问答
- 设置
- 快捷键
- 插件管理
- 安装包( PackageControl )
- 插件
- 语法
- SublimeLinter
- SublimeLinter-jshint
- SublimeLinter-php
- SublimeLinter-phplint
- SublimeLinter-phpmd
- SublimeLinter-phpcs
- 注释
- DocBlockr
- 排版
- HTML-CSS-JS Prettify
- phpfmt
- 模版
- SublimeTmpl
- ExtJS
- 安装
- 翻译
- ChineseLocalizations
- 辅助
- SideBarEnhancements
- Bracket Highlighter
- auto-save
- Color Highlighter
- ColorPicker
- 上传
- sftp
- 提示
- PhpNinJaManual
- 版本
- Git
- TortoiseSVN
- 框架插件
- PHP开发
- 编译系统
- 注释插件
- 代码片段
- Pretty Json
- 系统菜单
- 分屏
- 空格缩进
- 中文版
- brew