首页 > 郑州JAVA培训/ 正文

在软件编程写代码时什么样的注释是正确的？

2015-06-08 16:32:21 软件培训网 ℃

写过代码的，或者做个项目的都应该知道，一个项目里有好的代码注释，但是注释的形式因人而异，今天呢，我们就随软件培训网来看下什么样的注释才是正确的！

代码注释，可以说是比代码本身更重要。这里有一些方法可以确保你写在代码中的注释是友好的。

1.不要重复阅读者已经知道的内容

能明确说明代码是做什么的注释对我们是没有帮助的。

2.要注释说明推理和历史

如果代码中的业务逻辑以后可能需要更新或更改，那就应该留下注释:)

3.同一行的注释不要写得很长

没什么比拖动水平滚动条来阅读注释更令开发人员发指的了。事实上，大多数开发人员都会选择忽略这类注释，因为读起来真的很不方便。

4.要把长注释放在逻辑上面，短注释放在后面

注释如果不超过120个字符那可以放在代码旁边。否则，就应该直接把注释放到语句上面。

5.不要为了注释而添加不必要的注释

画蛇添足的注释会造成混乱。也许在学校里老师教你要给所有语句添加注释，这会帮助开发人员更好地理解。但这是错的。谁要这么说，那你就立马上给他个两大耳刮子。代码应该保持干净简洁，这是毋庸置疑的。如果你的代码需要逐行解释说明，那么你最需要做的是重构。

6.注释要拼写正确

不要为代码注释中的拼写错误找借口。IDE可以为你检查拼写。如果没有这个功能，那就去下载插件，自己动手！

7.要多多练习

熟能生巧。试着写一些有用的注释，可以问问其他开发人员你的注释是否有用。随着时间的推移，你会慢慢懂得怎样才算是友好的注释。

8.要审查别人的注释

在代码审查时，我们往往会忽略查看注释。不要怕要求更多的注释，你应该提出质疑。如果每个人都养成写好注释的好习惯，那么世界将会更美好。

总结

注释是开发进程中非常重要的一部分，但我们不应该为了注释而注释。注释应该是有用的，简洁的，应该是对代码的一种补充。注释不应该用于逐行地解释代码，相反，它应该用于解释业务逻辑，推理以及对将来的启示。

Tags：郑州java专业培训学校机构专业靠谱的,郑州java培训班哪家好,郑州Java培训班,郑州Java培训机构,郑州java培训机构有哪些,河南郑州java培训