PHP 解说:我为何一定强制要求 PHP 代码写注释?

软件就是代码与文档的总和。

我们在学习编程语言时,就被要求代码一定要写注释。

但是,注释真的有必要吗?

最近几年一直断断续续研读《代码整洁之道》此书。也从中汲取到很多有用的编程经验与思想。也让我把代码写得越来越有灵魂。

此书当中专门有一个章节来讲了应该怎样注释,应该如何避免坏的注释。但是,有一点我觉得不好。或者说对我们中国区的大多数 PHP 开发者来说不适用。

提倡代码即注释
就是指好的代码本身是不需要注释的。可以通过取有意义的方法名称、一个方法只做一件事情等等措施来让代码变得可读易懂。但是,我不认同这个观点。

PHP 属于弱类型语言。有时候我们的参数是什么类型完全不能通过方法定义就能完全知道。必须阅读源码才能精确知悉。

其次,我们有时候我们会传递数组参数。这个参数里面有哪些键,我们完全不知道。

再次,咱们中国程序员很多人其实英语普遍不是特别好。取名的时候很难取一个见名知义的名称。导致阅读性不高。当然,不排除有高端程序员,他们英文很好。代码也写得棒棒哒。这个没必须撕。

很多程序员代码拆分也不够好。往往一个方法能写上百上千行。有时候一个类文件能达到上万行代码量。像这种即使写了注释,我感觉也没用了。

所以,我们不仅要写好注释。还得有一个好的代码架构思想。

博主 2011 年创建了一个《PHP 初学者官方群》,目前群成员 500 人左右。群号:168159147。为了防止广告,设置为付费入群。欢迎大家加入讨论技术!

标签: 无

发表评论: