[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