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

栏目: PHP · 发布时间: 5年前

内容简介:软件就是代码与文档的总和。我们在学习编程语言时,就被要求代码一定要写注释。但是,注释真的有必要吗?

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

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

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

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

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

提倡代码即注释

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

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

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

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

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

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


以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

永无止境

永无止境

[美] 道格拉斯•艾德华兹 / 刘纯毅 / 中信出版社 / 2012-12-15 / 59.00元

★ 值得中国初创公司反复思考的企业传记 ★ 互联网行业必读书 ★ Google高管揭开Google的神秘面纱 ★ 探寻“G力量”重塑人类知识景观的心路历程 ★ Google走过的路,Google未来的路 ★ 编辑推荐: 它是目前被公认为全球最大的搜索引擎!它是互联网上五大最受欢迎的网站之一! 它在操作界面中提供多达30余种语言选择,在全球范围内拥有无数用户......一起来看看 《永无止境》 这本书的介绍吧!

URL 编码/解码
URL 编码/解码

URL 编码/解码

RGB HSV 转换
RGB HSV 转换

RGB HSV 互转工具