1、命名规范
变量、函数、常量、构造函数、类的成员等等的命名规范。一般采用驼峰式命名法,驼峰式命名法由小(大)写字母开始,后续每个单词首字母都大写。
1)Pascal Case 大驼峰式命名法
首字母大写:
例如,StudentInfo
、UserInfo
、ProductInfo
2)Camel Case 小驼峰式命名法
首字母小写:
例如,studentInfo
、userInfo
、productInfo
3)使用示例
// 变量使用小驼峰式命名法 var maxCount = 10; var siteName = 'cjavapy'; // 函数使用小驼峰式命名法 function canRead() { return true; } function getName() { return this.name; } // 常量字母全部大写 var MAX_COUNT = 10; var URL = 'http://www.cjavapy.com'; function Person(name) { this.name = name; } // 构造函数大驼峰式命名法 var p = new Person('levi'); /* 公共属性和方法:与变量和函数的命名一样。 私有属性和方法:前缀为_(下划线),后面跟公共属性和方法一样的命名方式。 */ function Person(name) { var _name = name; // 私有成员 // 公共方法 this.getName = function () { return _name; } // 公共方式 this.setName = function (value) { _name = value; } } var st = new Person('levi'); st.setName('cjavapy'); console.log(st.getName()); // => cjavapy:输出_name私有变量的值
2、注释规范
JavaScript(JS)中两种不同类型的注释:单行注释和多行注释。
1)单行注释
单独一行://
(双斜线)与注释文字之间保留一个空格。在代码后面添加注释:
//
(双斜线)与代码之间保留一个空格,并且//
(双斜线)与注释文字之间保留一个空格。
注释代码://
(双斜线)与代码之间保留一个空格。
2)多行注释
若开始(/*
)和结束(*/
)都在一行,推荐采用单行注释。
若至少三行注释时,第一行为/*
,最后行为*/
,其他行以*
开始,并且注释文字与*
保留一个空格。
3)函数注释
函数(方法)注释也是多行注释的一种,可能格式有一定的要求,
语法:
/** * 函数说明 * @关键字 */
例如,
/** * 重复输出 <tt>str</tt> 可以指定次数. * @param {string} str要重复的字符串. * @param {number} times字符串重复的次数. * @returns {string} */ function repeat (str, times) { return }
参考注释关键字:
注释名 | 语法 | 含义 | 示例 |
@param | @param 参数名 {参数类型} 描述信息 | 描述参数的信息 | @param name {String} 传入名称 |
@return | @return {返回类型} 描述信息 | 描述返回值的信息 | @return {Boolean} true:可执行;false:不可执行 |
@author | @author 作者信息 [附属信息:如邮箱、日期] | 描述此函数作者的信息 | @author 张三 2015/07/21 |
@version | @version XX.XX.XX | 描述此函数的版本号 | @version 1.0.3 |
@example | @example 示例代码 | 演示函数的使用 | @example setTitle('测试') |
3、其它规范
1)代码缩进
通常使用 4 个空格符号来缩进代码块:
例如,
function toCalc(a) { return (5 / 7) * (a - 32); }
注意:不推荐使用 TAB 键来缩进,因为不同编辑器 TAB 键的解析不同。
2)代码结束符
一行代码通常以分号作为结束符。
var values = ["c", "java", "python"];
3)文件扩展名和文件名
1)文件扩展名
HTML 文件后缀可以是 .html
(或 .htm
),CSS 文件后缀是 .css
,JavaScript 文件后缀是 .js
。
2)文件名
大多 Web 服务器 (Apache, Unix) 对大小写敏感: cjavapy.jpg
不能通过 Cjavapy.jpg
访问。其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感: cjavpay.jpg
可以通过 Cjavapy.jpg
或 cjavapy.jpg
访问。必须保持统一的风格,建议统一使用小写的文件名。