|
|
|
@ -239,7 +239,8 @@ public class HelloWorld { |
|
|
|
|
|
|
|
|
|
|
|
#### 六,代码注解 |
|
|
|
#### 六,代码注解 |
|
|
|
|
|
|
|
|
|
|
|
6.1 注解的原则 |
|
|
|
##### 6.1 注解的原则 |
|
|
|
|
|
|
|
|
|
|
|
好的命名增加代码阅读性,代码的命名往往有严格的限制。而注解不同,程序员往往可以自由发挥,单并不意味着可以为所欲为之胡作非为。优雅的注解通常要满足三要素。 |
|
|
|
好的命名增加代码阅读性,代码的命名往往有严格的限制。而注解不同,程序员往往可以自由发挥,单并不意味着可以为所欲为之胡作非为。优雅的注解通常要满足三要素。 |
|
|
|
|
|
|
|
|
|
|
|
1. Nothing is strange 没有注解的代码对于阅读者非常不友好,哪怕代码写的在清除,阅读者至少从心理上会有抵触,更何况代码中往往有许多复杂的逻辑,所以一定要写注解,不仅要记录代码的逻辑,还有说清楚修改的逻辑。 |
|
|
|
1. Nothing is strange 没有注解的代码对于阅读者非常不友好,哪怕代码写的在清除,阅读者至少从心理上会有抵触,更何况代码中往往有许多复杂的逻辑,所以一定要写注解,不仅要记录代码的逻辑,还有说清楚修改的逻辑。 |
|
|
|
|