目录
- 文件和路径
- 编码
- 缩进
- 每行字符数
- 行尾空白符
- 换行
- 文件末尾空行
- 文件行数
- 注释
DO
- 项目中的文件存放在同一个目录中
- 使用完整的相对路径引用其他文件
- 使用小写字母和数字
- 使用
.或-作为单词的连接符 - 路径中始终包含扩展名
DON'T
- 使用本地绝对路径
- 使用路径别名
使用 UTF-8（no BOM）。
DO
- 使用两个或四个空格缩进
DON'T
- 使用 Tab 缩进
- 混合多种缩进方式
每行尽量保持在 80 字符以内，不超过 100 字符。
行尾不使用任何空白符。
- 以保证代码易读为首要目标
- 通过缩进表现多行内容的关系
- 使用 Unix 换行符 LF
\n
文件末尾保留一个空行。
每个文件尽量保持在 500 行以内，不超过 1000 行。
- 在需要的地方添加注释
- 编写简洁、明确的注释内容