编码规范
命名
1、尽量不要用缩写词,比如msg、hp、list、a、b、...;这样很难看出代码要表达的意图,尽可能的使用能够表达清楚的词语或者短语,因为这个年代,已经有足够大的磁盘空间存放你的程序文件了。
2、做有意义的区分,很多时候为了省事,同类型的变量你会写成number1、number2、number3...。
3、不要添加冗余的前后缀,例如CustomerInfo、CustomerData、NameString、...直接用Customer、Name要比添加Info之类要简单清晰。
4、不要去创造或使用一些,连自己都读着绕口或者错误的名称,比如(西瓜Watermelon),不要写出这样的词语-WestFellow,如果不知道,你不会傻到连翻译工具都不会用吧。
5、比较有争议的一些命名方式,接口“I”前缀,变量前面加“_”;如果你觉得好就放心大胆的用吧。
6、类名应该使用名词或名词短语,例如Customer,Account、...避免使用Data、Info、Manager、...这样的类型,类名不应该用动词。
7、方法名应该用动词或者动词短语。
函数
1、尽量简小。
2、一个函数只做一件事,即看方法能不能再拆分出一个新的函数,而行的函数和该函数要做的不是同义层级的事。通过自顶向下的方式,阅读你的代码,将同一抽象级别的代码放在一起。
3、如果函数的参数操作三个以上,就要想着该把参数封装成一个类。
注释
1、优秀的代码,没有注释,代码本身就是说明一切。所以,尽可能的把代码写好吧。
2、如果做不到第一条,你还是乖乖的给代码写上注释吧,否则没人知道你的代码要干什么。
3、避免长篇大论的写一些没有用的信息。
4、合理的使用//TODO,为未完成的任务或者将来可能需要优化的地方加上备注。
5、使用源码控制工具代替日志式的注释。