原：http://www.ithao123.cn/content-719950.html 1、引子 在写代码的时候，尤其是写脚本，最需要注释了。目前脚本、样式的注释格式都有一个已经成文的约定规范（这些约定规范最初是YUI Compressor制定的，详见参考资料 ...

1、引子 在写代码的时候，尤其是写脚本，最需要注释了。 DocBlockr is a package for Sublime Text 2 & 3 which makes writing documentation a breeze. DocBlockr supports ...

DocBlockr很好用，不仅仅可以自动生成注释，还可以手动编辑注释的格式。 安装方法： Cmd+Shift+P -> Install Package -> docblockr windows是ctrl+shift+P 自定义配置： Preference ...

题引： 　　作为专业的js开发工程师，注释规范与否至关重要，下面推荐一下个人总结的javascript注释模板，采用jsDoc规范； 正文： 　　在一个文件中注释大概分三类：文档注释、函数（类）注释、（变量）常量注释 　　文档注释：告知他人该js文件主要处理的核心内容； 　　函数（类 ...

1 规范目的 一个软件的生命周期中，80%的花费在于维护； 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护； 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。为了执行规范，每个软件开发人员必须一致遵守编码规范； 使用统一编码规范 ...

一、gihub地址 https://github.com/spadgos/sublime-jsdocs/ 其中有使用的教程可以参考 二、配置示例 安装教程此处略，请自行查找教程 jsdocs_extra_tags表示额外的一些配置，@param、@return属于自带的配置 若想添加 ...

注释在代码编写过程中的重要性，写代码超过半年的就能深深的体会到。没有注释的代码都不是好代码。为了别人学习，同时为了自己以后对代码进行‘升级’，看看js/javascript代码注释规范与示例。来自：http://www.56.com/style/-doc-/v1/tpl ...

文件注释 文件注释位于文件的最前面，应包括文件的以下信息：概要说明及版本（必须）项目地址（开源组件必须）版权声明（必须）开源协议（开源组件必须）版本号（必须）修改时间（必须），以ISO格式表示（可使用Sublime Text的InsertDate插件插入）文件注释必须全部以英文字符表示 ...