auto commit

notes/代码可读性.md

@@ -29,13 +29,13 @@
 一些比较有表达力的单词：
 
 |  单词 |  可替代单词 |
-| --- | --- |
+| :---: | --- |
 |  send | deliver、dispatch、announce、distribute、route  |
 | find  |  search、extract、locate、recover |
 | start| launch、create、begin、open|
 | make | create、set up、build、generate、compose、add、new |
 
-使用 i、j、k 作为循环迭代器的名字过于简单，user_i、member_i 这种名字会更有表达力。因为循环层次越多，代码越难理解，有表达力的迭代器名字可读性会更高
+使用 i、j、k 作为循环迭代器的名字过于简单，user_i、member_i 这种名字会更有表达力。因为循环层次越多，代码越难理解，有表达力的迭代器名字可读性会更高。
 
 为名字添加形容词等信息能让名字更具有表达力，但是名字也会变长。名字长短的准则是：作用域越大，名字越长。因此只有在短作用域才能使用一些简单名字。
 
@@ -102,7 +102,7 @@ Map<String, Integer> scoreMap = new HashMap<>();
 添加测试用例来说明：
 
 ```java
-//...
+// ...
 // Example: add(1, 2), return 3
 int add(int x, int y) {
     return x + y;
@@ -124,14 +124,14 @@ int num = add(\* x = *\ a, \* y = *\ b);
 条件表达式中，左侧是变量，右侧是常数。比如下面第一个语句正确：
 
 ```java
-if(len < 10)
-if(10 > len)
+if (len < 10)
+if (10 > len)
 ```
 
 if / else 条件语句，逻辑的处理顺序为：① 正逻辑；② 关键逻辑；③ 简单逻辑。
 
 ```java
-if(a == b) {
+if (a == b) {
     // 正逻辑
 } else{
     // 反逻辑
@@ -163,12 +163,12 @@ if username == "root":
 使用摩根定理简化一些逻辑表达式：
 
 ```java
-if(!a && !b) {
+if (!a && !b) {
     ...
 }
 ```
 ```java
-if(!(a || b)) {
+if (!(a || b)) {
     ...
 }
 ```
@@ -179,18 +179,19 @@ if(!(a || b)) {
 
 ```java
 boolean done = false;
-while(/* condition */ && !done) {
+while (/* condition */ && !done) {
     ...
-    if(...) {
+    if ( ... ) {
         done = true;
         continue;
     }
 }
 ```
-```
+
+```java
 while(/* condition */) {
     ...
-    if(...) {
+    if ( ... ) {
         break;
     }
 }
@@ -203,7 +204,7 @@ JavaScript 可以用闭包减小作用域。以下代码中 submit_form 是函
 ```js
 submitted = false;
 var submit_form = function(form_name) {
-    if(submitted) {
+    if (submitted) {
         return;
     }
     submitted = true;
@@ -244,15 +245,15 @@ var setFirstEmptyInput = function(new_alue) {
     var found = false;
     var i = 1;
     var elem = document.getElementById('input' + i);
-    while(elem != null) {
-        if(elem.value === '') {
+    while (elem != null) {
+        if (elem.value === '') {
             found = true;
             break;
         }
         i++;
         elem = document.getElementById('input' + i);
     }
-    if(found) elem.value = new_value;
+    if (found) elem.value = new_value;
     return elem;
 }
 ```
@@ -265,12 +266,12 @@ var setFirstEmptyInput = function(new_alue) {
 
 ```js
 var setFirstEmptyInput = function(new_value) {
-    for(var i = 1; true; i++) {
+    for (var i = 1; true; i++) {
         var elem = document.getElementById('input' + i);
-        if(elem === null) {
+        if (elem === null) {
             return null;
         }
-        if(elem.value === '') {
+        if (elem.value === '') {
             elem.value = new_value;
             return elem;
         }
@@ -290,13 +291,13 @@ var setFirstEmptyInput = function(new_value) {
 int findClostElement(int[] arr) {
     int clostIdx;
     int clostDist = Interger.MAX_VALUE;
-    for(int i = 0; i < arr.length; i++) {
+    for (int i = 0; i < arr.length; i++) {
         int x = ...;
         int y = ...;
         int z = ...;
         int value = x * y * z;
         int dist = Math.sqrt(Math.pow(value, 2), Math.pow(arr[i], 2));
-        if(dist < clostDist) {
+        if (dist < clostDist) {
             clostIdx = i;
             clostDist = value;
         }
@@ -311,9 +312,9 @@ int findClostElement(int[] arr) {
 public int findClostElement(int[] arr) {
     int clostIdx;
     int clostDist = Interger.MAX_VALUE;
-    for(int i = 0; i < arr.length; i++) {
+    for (int i = 0; i < arr.length; i++) {
         int dist = computDist(arr, i);
-        if(dist < clostDist) {
+        if (dist < clostDist) {
             clostIdx = i;
             clostDist = value;
         }