JavaScript 编码规范
一首小诗
1.
前言
2.
代码风格
2.1.
文件
2.2.
结构
2.2.1.
缩进
2.2.2.
空格
2.2.3.
换行
2.2.4.
语句
2.3.
命名
2.4.
注释
2.4.1.
单行注释
2.4.2.
多行注释
2.4.3.
文档化注释
2.4.4.
类型定义
2.4.5.
文件注释
2.4.6.
命名空间注释
2.4.7.
类注释
2.4.8.
函数/方法注释
2.4.9.
事件注释
2.4.10.
常量注释
2.4.11.
复杂类型注释
2.4.12.
AMD 模块注释
2.4.13.
细节注释
3.
语言特性
3.1.
变量
3.2.
条件
3.3.
循环
3.4.
类型
3.4.1.
类型检测
3.4.2.
类型转换
3.5.
字符串
3.6.
对象
3.7.
数组
3.8.
函数
3.8.1.
函数长度
3.8.2.
参数设计
3.8.3.
闭包
3.8.4.
空函数
3.9.
面向对象
3.10.
动态特性
3.10.1.
eval
3.10.2.
动态执行代码
3.10.3.
with
3.10.4.
delete
3.10.5.
对象属性
4.
浏览器环境
4.1.
模块化
4.1.1.
AMD
4.1.2.
define
4.1.3.
require
4.2.
DOM
4.2.1.
元素获取
4.2.2.
样式获取
4.2.3.
样式设置
4.2.4.
DOM 操作
4.2.5.
DOM 事件
麦田技术博客
JavaScript 编码规范
2.4.3 文档化注释
[强制] 为了便于代码阅读和自文档化,以下内容必须包含以
/**...*/
形式的块注释中。
解释:
文件
namespace
类
函数或方法
类属性
事件
全局变量
常量
AMD 模块
[强制] 文档注释前必须空一行。
[建议] 自文档化的文档说明 what,而不是 how。