🔥码云GVP开源项目 12k star Uniapp+ElementUI 功能强大 支持多语言、二开方便! 广告
## 注释规范 * 所有js文件的开始部分都应有描述其功能的简要注释。这些注释并不描述细节信息(如何实现功能),这是因为细节有时要频繁更改。这样就可以避免不必要的注释维护工作以及错误的注释。细节信息由代码本身及必要的内部注释来描述。 * 每个重要的变量声明都应有内部注释,描述变量的用途。 * 应清楚地命名变量、控件和过程,仅在说明复杂细节时需要内部注释。 * 应在脚本的开始部分包含描述该脚本的概述,列举对象、过程、运算法则、对话框和其他系统从属物。有时一段描述运算法则的注释是很容易让人理解的。 * 注释一行代码用“//”标识,并且书写在需要注释的上一行,例如: `// 用于表示xx账户的名称 var strAdName;` * 注释块用“/**……*/”标识,例如: `/** * 主题:检查表单的完整性 * 作者:byron sampson * 描述:检查提交表单时内容是否完整 * 修改日志 * 日期 修改原因 修改人 版本 * 201430131 创建 byron 1.1 */`