Skip to content

Commit

Permalink
Merge pull request #124 from AprilLJX/master
Browse files Browse the repository at this point in the history
update a paragraph
  • Loading branch information
庄表伟 committed Oct 22, 2019
2 parents 35d33f7 + 946c220 commit 8045e23
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion zh/Understanding-the-source-code.md
Expand Up @@ -84,7 +84,7 @@ Java是一门很讲究规范的语言,所以他的每一个类,就会对应一

### 注释与Readme

很多时候,开源项目代码里的注释,会给你带来误导。或者会让人不知所云,或者只是写给自己看到TODO,或者代码改了,注释忘记改。种种原因,因此我强烈的不建议过于重视注释
很多时候,开源项目代码里的注释不仅不会帮助读者理解,反而会带来误导。或者因为语言表述让人不知所云,或者是用特定的缩写符号表示的只写给自己看的TODO,或者是改了代码而没有改注释,这些反而不利于读者理解代码,甚至造成理解错误。因此我强烈的不建议读者过于重视阅读注释

但是,在业内有一种流派,非常重视注释,而且信奉从源代码的注释,就可以直接生成项目的开发文档。比如JavaDoc这样的东西,在Java的开源项目里,简直用到泛滥,也造成了Java的很多项目,注释数量比代码的数量还要多。而且,格式规范,千篇一律(为了生成Document),真正有意义的注释内容,少之又少。纯粹是干扰阅读。

Expand Down

0 comments on commit 8045e23

Please sign in to comment.