本文介紹如何更加輕松的閱讀代碼。
有人會說,閱讀代碼是否輕松,取決于代碼的可讀性吧。是的,而且請不要誤會,本文不是要介紹編碼規范。不管代碼本身的可讀性如何,你都可以找到更好的手段去幫助閱讀。下面是幾個可供參考的建議:
1、用豐富的顏色區分類型、成員、方法、變量、參數等等。例如下面兩張圖片,你覺得哪個閱讀起來更輕松呢?


顏色的區分不僅僅是為了好看,顏色越多,代碼展示的信息就越豐富。特別是當有時候變量名稱覆蓋了成員名稱的時候,一眼就能看出來。
2、適當用空行將邏輯隔開。在下面的例子中,第一段的代碼沒有使用空行,看起來比較凌亂;第二段代碼只是加了幾個空行,邏輯馬上變得清晰起來,有利于閱讀。


3、為邏輯區塊添加注釋。有人說好的代碼不需要注釋,但一方面好的代碼太少,另一方面英語不是我們母語,所以適當的加上注釋是有必要的。

上面的代碼沒有加注釋,雖然邏輯做了一定的整理,但要看懂還是不容易。

加了注釋之后,看起來更輕松了。
另外,如果代碼當中的變量命名晦澀,可以用重構的方式對變量重命名,以方便閱讀。
有人會說,閱讀代碼是否輕松,取決于代碼的可讀性吧。是的,而且請不要誤會,本文不是要介紹編碼規范。不管代碼本身的可讀性如何,你都可以找到更好的手段去幫助閱讀。下面是幾個可供參考的建議:
1、用豐富的顏色區分類型、成員、方法、變量、參數等等。例如下面兩張圖片,你覺得哪個閱讀起來更輕松呢?


顏色的區分不僅僅是為了好看,顏色越多,代碼展示的信息就越豐富。特別是當有時候變量名稱覆蓋了成員名稱的時候,一眼就能看出來。
2、適當用空行將邏輯隔開。在下面的例子中,第一段的代碼沒有使用空行,看起來比較凌亂;第二段代碼只是加了幾個空行,邏輯馬上變得清晰起來,有利于閱讀。


3、為邏輯區塊添加注釋。有人說好的代碼不需要注釋,但一方面好的代碼太少,另一方面英語不是我們母語,所以適當的加上注釋是有必要的。

上面的代碼沒有加注釋,雖然邏輯做了一定的整理,但要看懂還是不容易。

加了注釋之后,看起來更輕松了。
另外,如果代碼當中的變量命名晦澀,可以用重構的方式對變量重命名,以方便閱讀。