起航学习网

如何维护代码也是个技术活，关键在于前期写代码的时候我们要做好工作，那么怎么样让代码好维护呢？

身为一个软件工程师，我们不可避免的会遇到这样一些问题：不得不修改别人的代码，或者在别人的代码中添加新的功能。我们并不熟悉这些代码，它也可能在整个系统中与我们编

先说说我们不喜欢的代码长什么样子，

1. 大函数，超过500行，甚至超过1000行；

2. 大量的hard coding；

3. if和else if中有明显的条件关联性；

4. 注释和代码逻辑不符合，函数名与功能不符合；

5. 命名英文拼音混杂，不少英文拼写错误；

。。。

说实话，这些问题很常见，无论是大厂，还是小团队。问题出现了，想出怎么解决才是关键。

每个团队都可以制定一套适合代码规范，不过光有代码规范是不够的。

比如说写代码文档，最重要的一点，不是什么格式规范，而是要说人话，解释清楚你做的事情，不要解释代码，否则文档本身就不具有可读性。

不要为了写注释而写，与其三心二意的写一堆注释，不如写几行足够清晰的程序。

[代码质量一直以来都是一个老生常谈的问题，只有更好的管理方法，没有绝对的高质量！]

接下来，我列几条我个人的经验：

1. 不要重复发明轮子，将公共的方法和函数抽出来做成公共库。投入一定的时间寻找和比较开源的解决方案，而非什么事情都自己实现。

2. 投入跟多的时间在接口的定义和审核上，一个差接口的危害性超过 500 行烂代码。

3. 请部门里更有经验的工程师帮助新人修改代码，相互工程师之间，相互抽查代码，这件事的好处不言而喻。虽然投入更多的时间，但是从整体效率的角度来讲，提高代码的可维护性就节省了大量的修改，重构代码的时间，可谓磨刀不误砍柴工。

4. 要求工程师对自己的代码写单元测试。这就使得程序员有机会从使用者的角度审视和检测自己的代码，这样不但能提高代码的易用性和正确性，而且在代码发生改变的时候，程序员可以确保不会破坏引用此段代码的其他模块或项目。

5. 从个人角度看，提高代码维护性，最直接的方式就是从好的代码Github上的代码库中学习，多看多总结。

6. 最后一点，也是我一直要求团队的一点，团队中的每个人都要有大局观意识，埋头苦干的前提是要了解全局，每位工程师都应该知道自己的东西在整个项目构架中的位置和他工作的意义。

文章出自：http://qh.itpxw.cn/peixun/software/201839194.html

文章标题：软件工程师如何提高维护代码的效率

免责声明：本站文章均由入驻起航学习网的会员所发或者网络转载，所述观点仅代表作者本人，不代表起航学习网立场。如有侵权或者其他问题，请联系举报，必删。侵权投诉