一高级工程师发帖：好的代码不需要注释？网友吵翻了

Posted 2022-09-16 黑马程序员官方

听说程序员最讨厌两件事，1.自己写注释，2.别人不写注释。如果有人对你说，我的代码很好，不需要注释，你的第一反应是什么？

最近，上网冲浪刷到这样一条帖子，一位程序员说：好的代码真的不需要注释！或许会被各种喷，但是我就是这么认为的！果不其然，网友们看法不一，评论区差点就要吵起来了！

今天，就来和大家一起聊聊代码注释。

原帖内容：

△ 图片来源于脉脉（如侵删）

网友评论：

内容较多，建议小伙伴们上下滑动，慢慢查看哦~

△ 图片来源于脉脉（如侵删）

从评论中我们可以看出，大部分程序员是支持写注释的。

他们认为，做好注释，不管是对你还是对公司来说都是非常重要的。

对于公司，好的注释以利于代码的维护，毕竟你写的代码后面或许是一个程序员或者多个程序员在维护，如果代码注释风格或者注释非常混乱，那么后面的程序员在接手你的代码时候，维护非常困难。

对于本人来说，好的注释，体现了你的职业精神和责任心，因为当领导或者其他程序员看到你的注释之后，就能够一眼看出你是否负责，是否为公司之后的维护着想。从某种程度上，代码注释反应了一个程序员的专业素养。

另一部分人认为，代码不需要注释。

代码即注释，只有烂的代码才需要注释。每个程序员的目标应该是编写干净和富有表现力的代码，以避免代码注释。每个变量，函数和类的目的应该隐含在其名称和结构中。

你是支持还是反对？

寻其根本，写注释是为了什么？

对于这个问题，我认为：注释就是对代码的解释和说明，目的是让人们能够更加轻松地了解代码，可以提高代码的可读性。

而提高可读性不一定就要靠尽可能多地写注释，甚至不一定要靠注释，不管你用什么办法，只要达到了“能让大多数人轻松看懂我的代码”的目标就可以了。

总结成一句话：不一定要写注释，但一定要思考这个问题；如果不确定，那就先写上。写好注释跟写好代码一样，是艺术活。