[TOC] ## 參考網址 ~~~ https://blog.csdn.net/hardgirls/article/details/52267486 ~~~ ## sublime3 docblocker插件定制自己的注釋，配置步驟 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/ 部分內容轉載至：http://fy98.com/2016/02/05/docblocker-usage/ ------------------------------------------ ------------------------------------------ ------------------------------------------ > 首先，我們需要安裝package control，已經安裝過package control的可以跳過這一步： 1. 打開sublime text 3，按快捷鍵Ctrl + ` 或者View->Show Console，復制粘貼如下代碼： 2. 安裝成功之后，重啟sublime text 3，快捷鍵Ctrl + Shift + P ，在輸入框中出入pack..找到Install Package。 3. 點擊Install Package，在輸入框中，安裝DocBlockr插件。 4. 安裝成功之后，Preferences->Package Settings->DocBlockr->Settings-User，在文件中添加以下代碼并保存： ~~~ { "jsdocs_extra_tags":["@author lucky","@DateTime {{datetime}}"] } ~~~ 5.函數前輸入：/** 點擊回車，將自動補全注釋，如下所示： ~~~ /** * 下載文件 * @author lucky * @DateTime 2018-02-26T17:08:12+0800 * @param [type] $path [description] * @param [type] $file_name [description] * @return [type] [description] */ public function downloadFile($path,$file_name){ $file_name = iconv("utf-8","gb2312",$file_name); $path = iconv("utf-8","gb2312",$path); // 首先要判斷給定的文件存在與否 if(!file_exists($path)){ $this->error('沒有該文件'); } $fp = fopen($path,"r"); $file_size = filesize($path); // 下載文件需要用到的頭 Header("Content-type: application/octet-stream"); Header("Accept-Ranges: bytes"); Header("Accept-Length:".$file_size); Header("Content-Disposition: attachment; filename=".$file_name); $buffer=1024; $file_count=0; // 向瀏覽器返回數據 while(!feof($fp) && $file_count<$file_size){ $file_con = fread($fp,$buffer); $file_count += $buffer; echo $file_con; } fclose($fp); } ~~~ ## 參考網址 https://blog.csdn.net/baidu_38300480/article/details/79379795 https://www.cnblogs.com/qingkong/p/5039527.html https://www.cnblogs.com/feifei-cyj/p/7718793.html