注释大家都会写,主要用来帮助程序员理解代码的意思,下面列举了几个真实的注释,如果是当您接手这样的项目看到这样的注释时,会做如何反应呢?笔者这里表示已经哭笑不得了…
1.看下面的这段C++注释,PS:新人表示看不懂
2.这家公司一定得罪这位web工程师了。。
3.改bug还是重写?
4、要是调试半天才看到这个语句,新人表示已泪奔
编程规范文档推荐
写代码和注释的第一目的是帮助人理解代码,理解作者的意图。所以优秀的代码本身就有自说明功能,只有在代码本身无法清晰地阐述作者的意图时,才考虑写注释,也即是:注释应该表达“我的代码为什么要这么做?”,而不是表达“我的代码做了什么?”
写注释应遵循奥卡姆剃刀原则:如无必要,勿增实体。注释写的不好、维护得不好(比如改了代码没改注释)会导致代码的可读性变差。
朋友们还遇到什么让您搞笑的注释呢?欢迎联系我们,分享您的“挨踢”趣事~
领取专属 10元无门槛券
私享最新 技术干货