js命名应遵循简洁、语义化的原则
一、变量命名法:小驼峰式命名法
命名约定:前缀为形容词(函数前缀为动词,以此区分函数和变量) )。
#良好的命名方法let maxCount=10; let tableTitle='或'; #不良命名方法let setConut=10; let getTitle='或'; 二、常数命名方法:名词均大写
命名约定:使用大写字母和下划线组合命名。 下划线用于分割单词。
const MAX_COUNT=10; const URL='//www.huifenqi.com '; 三、函数方法命名方法:小驼峰式命名法
命名约定:前缀必须是动词
命名建议:常用动词约定
JavaScript代码规范相同的规范适用于所有JavaScript项目。
JavaScript代码规范代码规范通常包括以下方面的:
变量和函数的命名约定使用空间、缩进和注释的规则。 其他一般规格……规格的代码容易阅读和维护。
代码一般在开发前规定,可以与团队成员协商设置。
变量名推荐驼峰法(大方的大船) :
第一个名称=' John ';
最后一个名称=' doe ';
price=19.90;
tax=0.20;
完整价格=价格(价格* Tax );
必须在空格和运算符常规运算符(= - * /)前后添加空格:
实例: varx=y z;
varvalues=['Volvo '、' Saab '、' Fiat'];
代码缩进通常使用四个空格符号来缩进代码块。
函数: functiontocelsius (Fahrenheit ) {
return(5/9) * ) * (fahrenheit -32;
}
不建议使用制表符缩进,因为不同的编辑器对制表符的分析不同。 语句规则简单句的通用规则:
句子通常以分号结尾。 实例: varvalues=['Volvo '、' Saab '、' Fiat'];
Var人员={
第一名: ' John ',
最后名字: ' doe ',
age:50,
eyeColor:'blue '
(;
复杂句子的通用规则:
将左大括号放在第一行的末尾。 在左大括号前添加空格。 将右大括号独立放置在一行上。 不要用分号结束复杂的声明。 函数: functiontocelsius (Fahrenheit ) {
return(5/9) * ) * (fahrenheit -32;
}
循环:for(I=0; i 5; I ) {
x =i;
}
条件语句:if(time20 ) {
greeting='Good day ';
}else{
greeting='Good evening ';
}
对象规则对象定义的规则:
将左大括号放在与类名相同的行上。 冒号和属性值之间有空格。 字符串使用双引号,不需要数字。 最后一个属性-请勿在值对之后添加逗号。 右大括号独立置于一行,以分号为终止符号。 实例: varperson={
第一名: ' John ',
最后名字: ' doe ',
age:50,
eyeColor:'blue '
(;
短对象代码可以直接写在一行:上
实例: var person={ first name : ' John ',lastName:'Doe ',age:50,eyeColor:'blue'};
每行的代码字符小于80,为了便于阅读,建议每行的字符小于几80。
如果JavaScript语句超过80个字符,建议在运算符或逗号之后换行。
实例: document.getelementbyid (' demo ' ).innerHTML=
' Hello Runoob.';
请试一下
命名约定一般很多代码语言的命名约定相似,例如:
变量和函数是小型驼峰匹配,除第一个单词外,其他单词是大写(lowerCamelCase)的全局变量
为大写 (UPPERCASE )常量 (如 PI) 为大写 (UPPERCASE )变量命名你是否使用这几种规则: hyp-hens, 大方的大船, 或 under_scores ?
HTML 和 CSS 的横杠(-)字符:
HTML5 属性可以以 data- (如:data-quantity, data-price) 作为前缀。
CSS 使用 - 来连接属性名 (font-size)。
- 通常在 JavaScript 中被认为是减法,所以不允许使用。下划线:
很多程序员比较喜欢使用下划线(如:date_of_birth), 特别是在 SQL 数据库中。
PHP 语言通常都使用下划线。
帕斯卡拼写法(PascalCase):
帕斯卡拼写法(PascalCase) 在 C 语言中语言较多。
驼峰法:
JavaScript 中通常推荐使用驼峰法,jQuery 及其他 JavaScript 库都使用驼峰法。
变量名不要以 $ 作为开始标记,会与很多 JavaScript 库冲突。 HTML 载入外部 JavaScript 文件使用简洁的格式载入 JavaScript 文件 ( type 属性不是必须的):
<script src="myscript.js">
使用 JavaScript 访问 HTML 元素一个糟糕的 HTML 格式可能会导致 JavaScript 执行错误。
以下两个 JavaScript 语句会输出不同结果:
实例var obj = getElementById("Demo")
var obj = getElementById("demo")
尝试一下 »
HTML 与 JavaScript 尽量使用相同的命名规则。
访问 HTML(5) 代码规范。
文件扩展名HTML 文件后缀可以是 .html (或 .htm)。
CSS 文件后缀是 .css 。
JavaScript 文件后缀是 .js 。
使用小写文件名大多 Web 服务器 (Apache, Unix) 对大小写敏感: london.jpg 不能通过 London.jpg 访问。
其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感: london.jpg 可以通过 London.jpg 或 london.jpg 访问。
你必须保持统一的风格,我们建议统一使用小写的文件名。
// 是否可阅读function canRead() {}// 获取名称function getName() {} 四、类 & 构造函数
命名方法:大写驼峰式命名法,首字母大写。
命名规范:前缀为名称。
class Persion { constructor(name) { ... }}let person = new Person('啦啦啦'); 五、类的成员
类的成员包括:
公共属性和方法: 跟变量和函数命名一样。私有属性和方法:前缀为下划线_, 后面跟公共属性和方法一样的命名方式。class Person { // 私有属性 _name: string; constructor() { } // 公共方法 getName() { return this._name; } // 公共方法 setName(name) { this._name = name; }} 六、注释规范
格式化插件推荐prettier
6.1 单行注释
// 设置标题setTitle()
6.2 多行注释
/* * 代码执行到这里后会调用setTitle()函数 * setTitle():设置title的值 */setTitle();
6.3 函数 & 方法注释
/** * 函数说明 * @关键字 **/
常用关键字注释
注释名语法含义示例@param@param {参数类型} 描述信息描述参数@param {String} name 传入名称@return@return {参数类型} 描述信息描述返回值@retun {Boolean} true: 可执行; false: 不可执行@author@author 描述信息描述作者@author 某某某 2018/04/24@example@example 示例代码演示函数的使用@example setTitle('啦啦啦');七、vue常用开发规范 参考vue风格指南7.1 importimport 应置于顶层, 引入组件名遵循大写驼峰式命名法。
import ElInput form '***'import Emitter from '***' 7.2 methods
命名方法:同函数命名法
命名建议:事件处理应以handle开头,如handleBlur
其他建议:使用promise或async/await处理异步逻辑,避免使用回调函数。