代码必须整洁!
代码必须整洁!!
代码必须整洁!!!
总原则
命名规范
使用大写字母开头,驼峰式,不能含有下划线
逻辑模块,请使用与该文件内所有类相同的名字
模块变量,使用大写字母开头,驼峰式,不能含有下划线
对象的内部变量,使用小写字母开头,驼峰式,不能含有下划线
命名需自解释其含义,不能书写注释
不合格 合格 var s;//启动服务器后的秒数
var secondsSinceStart;
常量定义,使用全大写字母加下划线的方式
文件
变量
公共函数,以小写开头,驼峰式,一般的,请以动词开头,名词结尾;或者单纯的一个动词
私有函数,仅当前文件使用,以公共命名方式前加一个下划线
成对的函数,请使用配对的同义词或者反义词,例如get/set, request/response, push/pop, add/delete, insert/remove, load/save, read/write, init/final
因js的特殊性,有些函数是实际上相当于类定义,要求其为大写字母开头,驼峰式,一般的,一个文件中仅存在一个类定义,要求其和文件名保持一致。
根据函数不同的返回值,可以明确定义函数的起始动词,一般的,这些动词都有固定的使用习惯
