命令名描述 @param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而且在将来的代码版本中将彻底删除.要避免使用这段代码@see 创建一个HTML链接,指向指定类的描述@version 指定发布版本@requires 创建一个HTML链接,指向这个类所需的指定类@throws @exception 描述函数可能抛出的异常的类型{@link} 创建一个HTML链接,指向指定的类…

命令名描述 @param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而且在将来的代码版本中将彻底删除.要避免使用这段代码@see 创建一个HTML链接,指向指定类的描述@version 指定发布版本@requires 创建一个HTML链接,指向这个类所需的指定类@throws @exception 描述函数可能抛出的异常的类型{@link} 创建一个HTML链接,指向指定的类…

安装和使用规范见:http://moodpo.com/archives/jsdoc3-tutorial.html 实例: /** * 模块调用方法 * * * @param {string} moduleName 模块名称 * @param {Function} callback 模块加载完成的回调,回调函数中会返回模块对象,方便内部调用 * @param {Boolean} isQueue 是否加入队列:在队列中的文件逐个加载(非异步) * @param {date} timeout 延时加载…

最佳原则 坚持制定好的代码规范. 无论团队人数多少,代码应该同出一门. 项目命名 全部采用小写方式, 以下划线分隔. 例:my_project_name 目录命名 参照项目命名规则: 有复数结构时,要采用复数命名法. 例:scripts, styles, images, data_models JS文件命名 参照项目命名规则. 例:account_model.js HTML文件命名 参照项目命名规则. 例:error_report.html 语法 缩进使用soft tab(4个空格): 嵌套的节…

JavaScript 注释规范 总原则 As short as possible(如无必要,勿增注释).尽量提高代码本身的清晰性.可读性. As long as necessary(如有必要,尽量详尽).合理的注释.空行排版等,可以让代码更易阅读.更具美感. 总之,注释的目的是:提高代码的可读性,从而提高代码的可维护性. 什么时候需要添加注释 某段代码的写法,需要注释说明 why 时: // Using loop is more efficient than `rest = slice.call…

注释在代码编写过程中的重要性,写代码超过半年的就能深深的体会到.没有注释的代码都不是好代码.为了别人学习,同时为了自己以后对代码进行'升级',看看js/javascript代码注释规范与示例.来自:http://www.56.com/style/-doc-/v1/tpl/js_dev_spec/spec-comment.html 文件注释 文件注释位于文件的最前面,应包括文件的以下信息:概要说明及版本(必须)项目地址(开源组件必须)版权声明(必须)开源协议(开源组件必须)版本号(必须)修改时间(…

原:http://www.ithao123.cn/content-719950.html 1.引子 在写代码的时候,尤其是写脚本,最需要注释了.目前脚本.样式的注释格式都有一个已经成文的约定规范(这些约定规范最初是YUI Compressor制定的,详见参考资料)了,如下: /** * 这里的注释内容[会]被压缩工具压缩 */ /*! * 这里的注释内容[不会]被压缩工具压缩 * 与上面一个注释块不同的是,第2个*换成了! */ 其中说到这里说到的压缩工具有YUI Compressor .Goo…

impress.js 中文注释 玄魂 /** * impress.js *(本翻译并未完全遵照原作者的注释翻译) * Impress.js 是受 Prezi启发,基于现代浏览器的 CSS3 与 JavaScript *语言完成的一个可供开发者使用的表现层框架. * * * Copyright 2011-2012 Bartek Szopka (@bartaz) * * Released under the MIT and GPL Licenses. * * --------------------…

               js的命名规范   1.驼峰命名法:首字母是小写的,接下来的字母都以大写字符开头.例如: var testValue = 0; var oneValue = 10; 2.帕斯卡命名法:首字母是大写的,接下来的字母都以大写字符开头.例如: var TestValue = 0; var OneValue = 10; 3.匈牙利类型标记命名法:在以帕斯卡命名的变量前附加一个小写字母(或小写字母序列),说明该变量的类型. 例如,i 表示整数,s 表示字符串,如下所示: va…

常用命名 列表,lUser 数组,arrUser 字符串,strTitle 用,分割的字符串,strStatuss(多个用逗号分割的状态) C# Entity层 统一以E开始,比如EUser,EOrder等 创建的对象为 var eUser=new EUser();   Repository层(持久化层) 统一以R开始 简单CURD命名:R+表名,比如RUser等 var rUser=new RUser(); 复杂Select命名:R+表名+Select var rUserSelect=new…