概述
四、编程规范
编程规范主要解决的是代码的可读性问题
命名与注释(Naming and Comments)
命名
命名的好坏,对于代码的可读性来说非常重要,甚至可以说是起决定性作用的。
在足够表达其含义的情况下,命名当然是越短越好
命名要符合项目的统一规范
注释
注释本身有一定地维护成本,所以并非越多越好。类和函数一定要写注释,而且要写得 尽可能全面、详细,而函数内部的注释要相对少一些,一般都是靠好地命名、提炼函数、解释性变量、总结性注释来提高代码可读性。
##代码风格(Code Style)
函数的代码行数不要超过一屏幕的大小,比如 50 行。类的大小限制比较难确定。
一行代码多长最合适?最好不要超过 IDE 的显示宽度。当然,也不能太小,否则会导致很多稍微长点的语句被折成两行,也会影响到代码的整洁,不利于阅读。
善用空行分割单元块。对于比较长的函数,为了让逻辑更加清晰,可以使用空行来分割
各个代码块。
编程技巧(Coding Tips)
将复杂的逻辑提炼拆分成函数和类。
通过拆分成多个函数或将参数封装为对象的方式,来处理参数过多的情况。
函数中不要使用参数来做代码执行逻辑的控制。
函数设计要职责单一。
移除过深的嵌套层次,方法包括:去掉多余的 if 或 else 语句,使用 continue、 break、return 关键字提前退出嵌套,调整执行顺序来减少嵌套,将部分嵌套逻辑抽象成函数。
用字面常量取代魔法数。
用解释性变量来解释复杂表达式,以此提高代码可读性。
最后
以上就是愤怒含羞草为你收集整理的四、编程规范四、编程规范的全部内容,希望文章能够帮你解决四、编程规范四、编程规范所遇到的程序开发问题。
如果觉得靠谱客网站的内容还不错,欢迎将靠谱客网站推荐给程序员好友。
本图文内容来源于网友提供,作为学习参考使用,或来自网络收集整理,版权属于原作者所有。
发表评论 取消回复