auto commit

notes/代码可读性.md

@@ -3,7 +3,7 @@
 * [二、用名字表达代码含义](#二用名字表达代码含义)
 * [三、名字不能带来歧义](#三名字不能带来歧义)
 * [四、良好的代码风格](#四良好的代码风格)
-* [五、编写注释](#五编写注释)
+* [五、为何编写注释](#五为何编写注释)
 * [六、如何编写注释](#六如何编写注释)
 * [七、提高控制流的可读性](#七提高控制流的可读性)
 * [八、拆分长表达式](#八拆分长表达式)
@@ -43,12 +43,14 @@
 
 起完名字要思考一下别人会对这个名字有何解读，会不会误解了原本想表达的含义。
 
-用 min、max 表示数量范围；用 first、last 表示访问空间的包含范围，begin、end 表示访问空间的排除范围，即 end 不包含尾部。
+布尔相关的命名加上 is、can、should、has 等前缀。
+
+- 用 min、max 表示数量范围；
+- 用 first、last 表示访问空间的包含范围；
+- begin、end 表示访问空间的排除范围，即 end 不包含尾部。
 
 <div align="center"> <img src="../pics//05907ab4-42c5-4b5e-9388-6617f6c97bea.jpg"/> </div><br>
 
-布尔相关的命名加上 is、can、should、has 等前缀。
-
 # 四、良好的代码风格
 
 适当的空行和缩进。
@@ -61,11 +63,9 @@ int b = 11;  // 注释
 int c = 111; // 注释
 ```
 
-语句顺序不能随意，比如与 html 表单相关联的变量的赋值应该和表单在 html 中的顺序一致；
+语句顺序不能随意，比如与 html 表单相关联的变量的赋值应该和表单在 html 中的顺序一致。
 
-把相关的代码按块组织起来放在一起。
-
-# 五、编写注释
+# 五、为何编写注释
 
 阅读代码首先会注意到注释，如果注释没太大作用，那么就会浪费代码阅读的时间。那些能直接看出含义的代码不需要写注释，特别是并不需要为每个方法都加上注释，比如那些简单的 getter 和 setter 方法，为这些方法写注释反而让代码可读性更差。
 
@@ -109,14 +109,6 @@ int add(int x, int y) {
 }
 ```
 
-在很复杂的函数调用中对每个参数标上名字：
-
-```java
-int a = 1;
-int b = 2;
-int num = add(\* x = *\ a, \* y = *\ b);
-```
-
 使用专业名词来缩短概念上的解释，比如用设计模式名来说明代码。
 
 # 七、提高控制流的可读性
@@ -128,16 +120,6 @@ if (len < 10)
 if (10 > len)
 ```
 
-if / else 条件语句，逻辑的处理顺序为：① 正逻辑；② 关键逻辑；③ 简单逻辑。
-
-```java
-if (a == b) {
-    // 正逻辑
-} else{
-    // 反逻辑
-}
-```
-
 只有在逻辑简单的情况下使用 ? : 三目运算符来使代码更紧凑，否则应该拆分成 if / else；
 
 do / while 的条件放在后面，不够简单明了，并且会有一些迷惑的地方，最好使用 while 来代替。