内容简介:软件就是代码与文档的总和。我们在学习编程语言时,就被要求代码一定要写注释。但是,注释真的有必要吗?
软件就是代码与文档的总和。
我们在学习编程语言时,就被要求代码一定要写注释。
但是,注释真的有必要吗?
最近几年一直断断续续研读《代码整洁之道》此书。也从中汲取到很多有用的编程经验与思想。也让我把代码写得越来越有灵魂。
此书当中专门有一个章节来讲了应该怎样注释,应该如何避免坏的注释。但是,有一点我觉得不好。或者说对我们中国区的大多数 PHP 开发者来说不适用。
提倡代码即注释
就是指好的代码本身是不需要注释的。可以通过取有意义的方法名称、一个方法只做一件事情等等措施来让代码变得可读易懂。但是,我不认同这个观点。
PHP 属于弱类型语言。有时候我们的参数是什么类型完全不能通过方法定义就能完全知道。必须阅读源码才能精确知悉。
其次,我们有时候我们会传递数组参数。这个参数里面有哪些键,我们完全不知道。
再次,咱们中国 程序员 很多人其实英语普遍不是特别好。取名的时候很难取一个见名知义的名称。导致阅读性不高。当然,不排除有高端程序员,他们英文很好。代码也写得棒棒哒。这个没必须撕。
很多程序员代码拆分也不够好。往往一个方法能写上百上千行。有时候一个类文件能达到上万行代码量。像这种即使写了注释,我感觉也没用了。
所以,我们不仅要写好注释。还得有一个好的代码架构思想。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网
猜你喜欢:- xml中的空格之完全解说
- CSS处理文本过长或超出部分(解说二)
- iOS 注释方法大全 代码块加快捷键注释
- 让 MyBatis Generator 用数据库注释作 Java 注释,并支持附加注解
- 请停止代码注释
- 体面编码之代码注释评论
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
Programming Amazon Web Services
James Murty / O'Reilly Media / 2008-3-25 / USD 49.99
Building on the success of its storefront and fulfillment services, Amazon now allows businesses to "rent" computing power, data storage and bandwidth on its vast network platform. This book demonstra......一起来看看 《Programming Amazon Web Services》 这本书的介绍吧!