如何提高代码可读性、可维护性

如何提高代码可读性、可维护性
 

1、高质量代码的三大要素：

可读性、可维护性和可变更性。

2、任何语言都需要强调编码风格的一致性。只要是团队开发，每个人都以相同的方式编写就是至关重要的。这样大家才能方便地互相看懂和维护对方的代码。

3、代码的可读性

代码的可读性是指代码让人容易阅读、跟踪和理解的程度。提高代码的可读性可以为代码阅读者节约时间（避免阅读时浪费过多无谓的时间）和精力（Debug、扩展功能或是性能优化的前提条件是你要读懂这段代码）。以下是摘选的可供参考的策略：

(1)编码风格一致

(2)代码清晰表达意图

(a)写别人看得懂的单词，如果选用英语，那么避免日语、法语和汉语拼音等，尽量使用语义化的命名组合；

(b)能够让人快速看懂（最低限度的要求是自己一个月后能快速读懂）；

(3)恰到好处的注释

(a)不能太多或太少，注释的形式根据代码具体的情况有不同；

(b)避免用注释包裹代码；

(c)尽量留下简明扼要的注释； 办公软件

(4)简单就是美，避免简单的功能写出复杂的代码；

(a) 坚持操作方法的原子性，而后使用组合模式实现业务逻辑； 

(b) 避免大段代码，要写高内聚、低耦合的代码；

 

代码谁都会写，但不是谁都能写好，简洁的代码远比复杂代码难写。现在写的代码你一个月几个月后能看懂吗？维护的人能看懂吗？项目是长期的，不是你现在写完就完事了，是要维护的。

理解注释度的把握：注释不能写成了文章，起到公路牌作用即可。

转自：https://blog.csdn.net/zm1_1zm/article/details/51983809