大部分的程序员都会有一种通病，最讨厌两件事：“别人代码不写注释”和"让我写注释"。每当身边有同事离职的时候，这种感觉就愈加强烈，因为项目需要其他人来继续维护或者开发。经常会有人边看边骂，这是啥？这又是啥？简直是一种折磨。

先别急着骄傲，“哼！我写的代码肯定不能这样”，等你几个月过去了再回头看，别说是别人，就连你自己可能都看不懂。为什么会出现这种情况呢，接下来我们就来分析一下！

代码没有注释

代码写注释对代码读取有着非常好的辅助功能，不仅能够让人快速的理解你写的代码的功能，同时还能让你以后回头看自己写的代码也能够迅速理解，修改或者排错。不能光为了图一时的方便，要想到与你合作或者是以后要接手你项目的人。

代码变量命名随意

刚学代码的时候，26个字母就能解决问题，26个字母不够还能加上数字，比如abc，a1... 但是到了项目中，不根据上下文可能神仙都看不懂，如果全文都是这样的命名，可能谁看都要疯。

方法分工不明确

一个简单方法中夹杂着许多种功能，让人看了之后很难说出这个方法到底是实现哪些功能的，看不懂，更加不敢轻易去改动。

面向过程去写代码

很多程序员都是为了能够按时工作就不注重代码的质量了，对自己的要求也是“能实现功能就ok”，这种代码将来就十分不好维护。

那么该如何解决这些问题呢？

注释尽量写的详细

每个类，每个方法都要写明注释， 类的注释可以简明写这个类的主要功能，但是每个方法的注释尽量要写细了，注释一定要覆盖方法中所实现的所有功能，而不是只写其中一部分。看过系统级源码的程序员都知道，注释的行数是比代码的行数还要多的。这就是优秀的习惯，我们也要去学习、掌握。

而且还有很多程序员喜欢用英文写注释，但是如果你的英语水平有限，那就尽量不要写英文注释了，毕竟，难为自己，还难为他人。

不要随便定义临时变量

尽量不要定义一些临时的变量，如果十分必要定义时，最好是加上单行注释，让其他人知道你的意图。命名其实是一件困难的事情，要想出一个恰到好处的命名需要一番功夫，尤其我们的母语还不是编程语言所通用的英语。好的命名让你的代码更直观，更有表达力。

•  名副其实

好的变量名告诉你：是什么东西，为什么存在，该怎么使用，如果需要通过注释来解释变量，那么就先得不那么名副其实了。避免误导

• 不要挂羊头卖狗肉，不要覆盖惯用缩略语！

• 有意义的区分

代码是写给机器执行，也是给人阅读的，所以概念一定要有区分度：

• 使用读的出来的单词

如果名称读不出来，那么讨论的时候就会很尴尬。

• 使用方便搜索的命名

名字长短应与其作用域大小相对应！避免思维映射。比如在代码中写一个 temp，那么读者就得每次看到这个单词的时候翻译成其真正的意义。

实现功能前先设计好代码

写代码之前最好先想好功能之后去设计下代码，想好文件名，类名以及方法名，用标准的英文去表示，尽量做到见名知意，需要用多个英文表示就用驼峰标识来表达。让人看上去结构一目了然，代码看上去让人赏心悦目。

转载文章和图片均来自公开网络，版权归作者本人所有。如有侵权，联系删除。