命名规范
1.使用专业的单词—例如,不用Get,而使用Fetch或者Download,这由上下文决定
2.避免使用空泛的名字,如他们tmp,retval,temp,除非使用他们有特殊的理由。
3.使用具体的名字来描述函数名。函数的作用尽量在函数名中体现。
4.为变量名加上重要的细节。如值为毫秒的变量后面加上_ms,制为米的的变量后面加上_m。
5.为作用域大的名字采用更具体的名字来描述。
6.有目的的使用大小写,下滑线来描述变量名。
注释
1..注释应该包括你当时写代码时的想法,如这行代码为什么要这样写而不那样写的原因。
2. 对于代码中的缺陷,应该是用TODO:来标记。
3. 对于常量的注释应该写明这个常量是用在哪里,有什么作用。
4. 对于那些别人看起来会有疑问的地方应该给予注释。
5. 用注释来总结代码块。
6. 对于用于创建对象的类应该给予详细的注释,这其中可以包括这个类如何使用,有什么功能。
7. 对于函数名无法完全的描述出函数的作用时,需要给予注释,或是给予一个例子。
循环和逻辑
1.利用德摩定律来操作逻辑表达式,如(!(a&&!b))变成(!a||b)。
2.一个if语句内没有超过两个值是理想情况。
3.减少没有价值的临时变量。
4.更多的使用局部变量代替全局变量。减少每个变量的作用域。
5.通过整理代码结构来明确每个变量的应用范围,并且在未使用时先别声明变量。
6.多使用常量使得程序的可读性更佳。
7.通过代码整理将做相同功能的的代码分布在同一块,尽量符合一次只做一件事的原则。
8.在编写逻辑代码块时,可以先用自然语言描述程序然后再根据描述来写代码。
9.不要过度设计,如一个函数不用用到那么多种重载方式的就不用事先写好一大堆重载。
扫一扫
478
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
