程序员是否有义务做好代码的注释？你做好代码注释了吗？

点击上方的终端研发部，右上角选择“设为星标”

每日早10点半，技术文章准时送上

公众号后台回复“学习”，获取作者独家秘制精品资料

正文

关于编程，代码注释是一个很重要的部分，从某种程度上，代码注释也反应了一个程序员的专业素养，下面我们就来聊聊程序员和代码注释的那些事。

一些典型的场景

场景一：某天，一个程序员因为一些事情感到心理很委屈，于是他决定，以后写代码的时候，我尽量将注释写得模棱两可，写得简单些。

场景二：某天，一个程序员因为工作分配不均，然后他决定，尽可能的少写注释或者文档。

两种常见的注释

//和/**/是我们程序员常用的两种注释，其中前者是行注释，后者是块注释。

利用行注释的地方大多是函数或者方法里面，我们仅仅针对某行做一个简单的说明。

利用块注释的地方大多是，类、方法、函数说明等等，以及方法里面某个核心的代码块说明。

在一些特殊的开发环境或者业务场景，常见的注释还有#，比如一些Apache的配置文件、php的配置文件、MySQL的配置文件等等。

好的注释作用非常大

其实做好注释，不管是对你还是对公司来说都是非常重要的。

对于公司，好的注释以利于代码的维护，毕竟你写的代码后面或许是一个程序员或者多个程序员在维护，如果代码注释风格或者注释非常混乱，那么后面的程序员在接手你的代码时候，维护非常困难，所以一般的代码注释，都是依据某种规范来进行的，比如PHP里面的PSR规范等。

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

所以不管怎么样，作为程序员的我们，应该尽心做好代码的注释。你觉得有必要做好代码的注释吗？

阅读更多

相信自己，没有做不到的，只有想不到的

在这里获得的不仅仅是技术！

喜欢就给个“在看”