代码中对所有东西的命名,一律采用驼峰命名法,例如checkProperty,而不要命名为 check_property
- 关于类型的总体原则,包括变量、方法返回值、形参等,全部加上类型,并且类型越具体越好。any类型的变量尽可能的少用。
- 作用域大于等于类时,必须严格遵守这个规范,不允许无类型。包括类的成员变量、成员方法(形参和返回值),包括全局变量、方法。
- 对于函数的局部变量、代码块内的局部变量,在编译器能够精确推导得到其类型时,可以忽略类型。比如 `const a = "a string"`;
- 所有命名严禁以拼音来命名,必须以词义恰当的英语单词来命名。命名时,要注意单词的时态、单复数等情况。总体原则是让他人能够“顾名思义”,而不用去猜测其作用。
- 命名时,尽量避免使用缩写(现在的IDE提示很强大,即使很长的变量名,也不需要手敲很多字符),不要出现类似`checkPropStatus`一半单词缩写一半全写的情形。
- 尽量采用约定俗成的缩写,不要自己发明,比如property常常缩写为prop,就别自己发明一个prpt,pro,proper这样的奇怪的缩写。
- 所有的类、接口、自定义类型、枚举类名,都以大写字母开头。其中接口一律以字母I开头,抽象类一律以Abstract开头,枚举项以小写字母开头。
- 所有的方法、变量,都以小写字母开头。所有json对象的属性,也以小写字母开头
- 对于方法命名
- 命名时一般以动宾结构的方式,比如checkProp