如果说要往程序注入灵魂的话，使用注释无疑是最快捷的方式。
你想吐槽一下产品经理，不好明面上说，可是心里头老这么压抑着，也不是办法。行，写到注释里吧。
或者使用一句话，委婉的表达整个页面的意思。
如果使用电子简历求职，职位要求想要隐晦的要求，可以学学Google联合创始人谢尔盖·布林，将自己真实的职业追求：“钱多活少办公室大最好还能经常去国外旅游并能报销”，写在代码注释里。
在正式工作中，程序员是十分讨厌注释的，他们讨厌：
1.写注释，写文档；
2.别人不写注释，不写文档；
就算别人写了注释，90%的注释，都是长这个样子的：
刚写完，你根本不需要看这样的注释；
一周后，这只猫是干啥的？
一年后，这里为什么有只猫？
五年后，这猫屎谁拉的？
注释是程序的灵魂，但绝大多数程序员，并不能写出一手好注释，要么画蛇添足，甚至祸害你的接盘侠。
身为一个合格的程序员，该怎么写好注释呢？
在《代码大全》中，将注释分为了5个类别。
1.代码的重复
用不同的词语，重申代码的内容
2.解释代码
解释比较复杂的代码，这种类型的代码，往往可以通过代码的优化，使代码本身更清晰。当然，进度优先时，这类代码是有必要的，有利于今后的维护。
小编是一个有着6年工作经验的工程师，关于C++，编程，自己有做材料的整合，一个完整的C++编程学习路线，学习资料和工具，能够进我的群7253，-91790收取，免费送给大家，希望你也能凭着自己的努力，成为下一个优秀的程序员
3.标记型注释
//这里有必要做个优化
//这里还没写完
经验表明，如果你这样写了，通常来说，这些事你都不会去做。这些事情，应该在提交代码前，就把它做完。
另外，这类注释最好要加上一些关键的信息，如姓名、日期、联系方式、提示等，方便grep。
4.总结代码
将一整块代码总结为一句或两句话，这样的注释，能帮助他人快速理解代码。
5.代码的意图
解释代码的目的，最初的编程意图是什么，打算解决什么难题？
只有“总结代码”、“代码的意图”这两类的注释是最有效的，也是最能体现注释作用的形式。关于C++，自己有做材料的整合，一个完整的学习C++的路线，学习材料和工具。能够进我的。企鹅裙。里；--先72，53；后917，90。收取，免费给大家，希望你也能凭自己的努力，成为下一个优秀的程序员。
换一种说法，总结代码、表示代码意图的注释，才是真正意义上的好注释。
注释很简单//，<!-- -->，/* */，每一门编程语言的写法，都很简单，但想写好注释，仍具备一定的挑战性。
网友评论