当我们表达一个意思时,往往会有许多不同的说法,这些说法都是正确,在我们编写代码时,也会有这样的情况,命名时,会有不同的命名方法,完成同一个功能,总是有不同的方法,他们都可能是正确的,从方便管理和可阅读性的角度考虑,我们应该统一编码的基本规约,从正确的编写方式中选择一种,然后团队中所有人一起遵守这个规约。
这个规约最重要的必须存在,让团队的成员有标准可以去执行,具体的内容只要合理即可,细节也可以在实践中不断去丰富,Java的规约可以参考阿里的文档,JavaScript可以参考如下:
- 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
- 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。
反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3 正例: alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。 - 【强制】文件命名使用UpperCamelCase风格,必须遵从驼峰形式。文件名按照层级的方式,高的层级在前,低的层级在后。
正例: ArticleList / ArticleEditorCreate / ArticleEditorUpdate
说明: Article表示是与Article相关的文件;List表示展示的内容是列表,Editor表示对Article进行编辑;Create、Update表示编辑Article后分别进行创建和更新操作。 - 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。变量名首字母必须小写;函数首字母小写,第一个单词使用动词。
正例: localValue / getHttpMessage() / inputUserId - 【强制】杜绝完全不规范的缩写,避免望文不知义。
反例: condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。 - 【推荐】函数保持单一职责,只做一件事;如需要在同一函数中完成多个功能请在函数命名上体现。
说明: 函数添加子元素并刷新页面,请使用addChildAndRefresh,而不是addChild - 【推荐】函数参数保持1-2个,合并同一个对象的不同属性。
- 【推荐】每一个函数一个抽象层级,流程与业务不要同时出现在一个函数中。
说明: 为表单添加字段,根据字段类型赋予不同的初始值;为表单添加字段为第一抽象层级,赋予初始值为第二抽象层级,具体使用如下:
addFieldToForm(field, form) {
if (field.type === 'text') {
setTextDefaultValue(field)
} else if(field.type === 'number') {
setNumberDefaultValue(field)
}
from.appendChild(field)
}
复制代码