auto commit

docs/notes/代码可读性.md

@@ -1,4 +1,20 @@
-[TOC]
+<!-- GFM-TOC -->
+* [一、可读性的重要性](#一可读性的重要性)
+* [二、用名字表达代码含义](#二用名字表达代码含义)
+* [三、名字不能带来歧义](#三名字不能带来歧义)
+* [四、良好的代码风格](#四良好的代码风格)
+* [五、为何编写注释](#五为何编写注释)
+* [六、如何编写注释](#六如何编写注释)
+* [七、提高控制流的可读性](#七提高控制流的可读性)
+* [八、拆分长表达式](#八拆分长表达式)
+* [九、变量与可读性](#九变量与可读性)
+* [十、抽取函数](#十抽取函数)
+* [十一、一次只做一件事](#十一一次只做一件事)
+* [十二、用自然语言表述代码](#十二用自然语言表述代码)
+* [十三、减少代码量](#十三减少代码量)
+* [参考资料](#参考资料)
+<!-- GFM-TOC -->
+
 
 # 一、可读性的重要性
 
@@ -32,11 +48,11 @@
 - 用 min、max 表示数量范围；
 - 用 first、last 表示访问空间的包含范围；
 
-<img src="https://cs-notes-1256109796.cos.ap-guangzhou.myqcloud.com/7d97dde0-0695-4707-bb68-e6c13a2e1b45.png" width="200px">
+<div align="center"> <img src="https://cs-notes-1256109796.cos.ap-guangzhou.myqcloud.com/7d97dde0-0695-4707-bb68-e6c13a2e1b45.png" width="200px"> </div><br>
 
 - begin、end 表示访问空间的排除范围，即 end 不包含尾部。
 
-<img src="https://cs-notes-1256109796.cos.ap-guangzhou.myqcloud.com/d85870db-f28c-48c3-9d24-85a36fda5e51.png" width="200px">
+<div align="center"> <img src="https://cs-notes-1256109796.cos.ap-guangzhou.myqcloud.com/d85870db-f28c-48c3-9d24-85a36fda5e51.png" width="200px"> </div><br>
 
 # 四、良好的代码风格
 
@@ -144,7 +160,7 @@ if (!(a || b)) {
 
 # 九、变量与可读性
 
-**去除控制流变量** 。在循环中通过使用 break 或者 return 可以减少控制流变量的使用。
+**去除控制流变量**  。在循环中通过使用 break 或者 return 可以减少控制流变量的使用。
 
 ```java
 boolean done = false;
@@ -166,7 +182,7 @@ while(/* condition */) {
 }
 ```
 
-**减小变量作用域** 。作用域越小，越容易定位到变量所有使用的地方。
+**减小变量作用域**  。作用域越小，越容易定位到变量所有使用的地方。
 
 JavaScript 可以用闭包减小作用域。以下代码中 submit_form 是函数变量，submitted 变量控制函数不会被提交两次。第一个实现中 submitted 是全局变量，第二个实现把 submitted 放到匿名函数中，从而限制了起作用域范围。
 
@@ -196,7 +212,7 @@ JavaScript 中没有用 var 声明的变量都是全局变量，而全局变量
 
 变量定义的位置应当离它使用的位置最近。
 
-**实例解析** 
+**实例解析**  
 
 在一个网页中有以下文本输入字段：
 
@@ -315,3 +331,10 @@ public int findClostElement(int[] arr) {
 # 参考资料
 
 - Dustin, Boswell, Trevor, 等. 编写可读代码的艺术 [M]. 机械工业出版社, 2012.
+
+
+
+
+
+
+<div align="center"><img width="320px" src="https://cs-notes-1256109796.cos.ap-guangzhou.myqcloud.com/githubio/公众号二维码-1.png"></img></div>