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