Files
RootPanel/DOC/Coding-Style.md
2014-10-07 03:54:59 +08:00

1.1 KiB

文件

  • .md 使用 4 空格缩进,文件名使用大驼峰用连字符分割
  • .coffee, *.js, *.json, *.html, *.less, *.jade 使用 2 空格缩进,文件名使用全小写用下划线分割

依赖

  • 加入依赖时注意检查必须允许发布闭源版本,即不能使用 GPL 授权的依赖

Node.js

  • 优先使用单引号,总是在行末添加分号
  • 只在初始化时使用 Sync 版本的 IO 函数

Coffee Script

  • ,, : 之前不加空格,之后总是添加空格;-> 前后均加空格
  • 不可以出现空的参数列表
  • 不在行末添加分号,不在一行内使用分号分割两行代码
  • 类名使用大驼峰命名,如 SampleClass
  • 优先使用单引号
  • 总是省略所有跨行的括号和花括号,尽可能省略掉函数调用的括号
  • 变量名使用全小写用下划线分割,函数名使用小驼峰

命名

  • 尽量不缩写术语
  • 总是使用 callback 命名回调函数
  • t_ 前缀表示这是一个待翻译的字符串 ID
  • l_ 前缀表示这是一个已经翻译好的字符串

HTML

  • CSS 类名和 ID 使用全小写用连字符分割