sublime注釋插件DocBlockr


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/


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2026 CODEPRJ.COM