好的代碼是不需要注釋的官疲，因為它本身就能夠自我說明泳叠，加上注釋反而顯得比較多余耀怜。不好的代碼只看代碼本身沒法明白代碼所表達的東西恢着，必須借助注釋才可以。雖然說注釋應(yīng)該作為一種規(guī)范财破，但我們還是應(yīng)該盡量去提升代碼的易讀性掰派、自我解釋性。
說一下我對自我解釋性很強的代碼的理解和實踐吧左痢，不一定完全正確靡羡，僅供參考系洛。
計算機中有個“ 元數(shù)據(jù)”的概念，即描述數(shù)據(jù)的數(shù)據(jù)亿眠，比如描述進程的pcb碎罚，描述文件的fcb磅废，描述http請求體的頭字段等纳像，說起來注釋也是一種元數(shù)據(jù)。
個人覺得在程序中拯勉， 變量名就是一個元數(shù)據(jù)竟趾，他描述了他所存儲的變量的內(nèi)容，我們要求變量名要見名知意宫峦，這樣閱讀代碼的時候就能清晰的理出哪段邏輯處理的是什么數(shù)據(jù)岔帽，其實這個和注釋的功能類似。自我解釋性很強的代碼就依賴于此导绷。同理犀勒，函數(shù)名、類名妥曲、文件名贾费、模塊名、甚至項目名都有類似的作用檐盟，我們封裝函數(shù)褂萧、類，拆分文件葵萎、模塊导犹、劃分項目等，除了是為了邏輯復用羡忘，也有描述邏輯本身的作用谎痢。自我解釋性很強的代碼正是基于此。
1. 復雜邏輯的中間結(jié)果需要用變量存儲
有一些邏輯需要從輸入經(jīng)歷一系列的處理步驟才能得到最終的數(shù)據(jù)卷雕，這個過程會有很多的中間結(jié)果节猿，有時候邏輯特別復雜，而一些中間結(jié)果比較有意義爽蝴，這時候把這些中間結(jié)果用見名知意的變量所存儲沐批，會使得代碼更加易讀。舉個栗子：
一段描述“如果明天下雨蝎亚，我就不去動物園了”的邏輯的代碼
if (空氣濕度大于 xxx && 風力大于xxx && 溫度低于 xxx) {
不去動物園();
}
去動物園();
其中“ 空氣濕度大于 xxx && 風力大于xxx && 溫度低于 xxx ”描述的邏輯就是 下雨九孩，但看邏輯卻并不能一眼看出來，這時候最常見的優(yōu)化思路當然就是注釋：
if (空氣濕度大于 xxx && 風力大于xxx && 溫度低于 xxx) { // 如果明天下雨
不去動物園();
}
去動物園();
這樣是可以提升代碼的易讀性和可維護性发框，但可能會有如果這段邏輯變更躺彬，那么注釋也要同步更新等一系列的問題，最好的優(yōu)化方式就是提升代碼本身的自我解釋性，比如這里簡單的加一個變量或者封裝一個函數(shù)或工具類宪拥。
let 明天下雨 = 空氣濕度大于 xxx && 風力大于xxx && 溫度低于 xxx;
if (明天下雨) {
不去動物園();
}
去動物園();
or
function 明天是否下雨() {
return 空氣濕度大于 xxx && 風力大于xxx && 溫度低于 xxx;
}
if (明天是否下雨() === true) {
不去動物園();
}
去動物園();
以上兩種方式都是自我解釋性很強的仿野，當然別的封裝形式也可以。封裝和拆分她君， 復用是一個目的脚作，同時見名知意的名字也能起到元數(shù)據(jù)的作用，提高代碼的簡潔和易讀性缔刹。
2. 步驟清晰的邏輯應(yīng)當在代碼中清晰的表現(xiàn)出來
有一些邏輯步驟很清晰球涛，這時候就應(yīng)該在代碼中明確的表現(xiàn)出這種清晰來，比如：
把大象裝冰箱一共分幾步：
一種寫法：
把冰箱門打開xx();
把冰箱門打開yy();
把冰箱門打開zz();
把大象裝進去xx();
把大象裝進去yy();
把大象裝進去zz();
把冰箱門關(guān)上xx();
把冰箱門關(guān)上yy();
把冰箱門關(guān)上zz();
這樣是很常見的寫法校镐，也能實現(xiàn)功能亿扁，但是代碼的可維護性卻可能很低，我遇到的很多一個函數(shù)好幾百行代碼的鸟廓，一個文件幾千行代碼的都是這種問題从祝。
這種邏輯清晰的，這樣封裝一下會更好：
function 把冰箱門打開(){
把冰箱門打開xx();
把冰箱門打開yy();
把冰箱門打開zz();
}
function 把大象裝進去() {
把大象裝進去xx();
把大象裝進去yy();
把大象裝進去zz();
}
function 把冰箱門關(guān)上() {
把冰箱門關(guān)上xx();
把冰箱門關(guān)上yy();
把冰箱門關(guān)上zz();
}
把冰箱門打開();
把大象裝進去();
把冰箱門關(guān)上();
雖然總體代碼量是增加的引谜，但是邏輯的清晰度卻提升了一個檔次牍陌。當然這里的函數(shù)換成類、模塊等都可以煌张。
3.用到的一些設(shè)計模式要加上對應(yīng)的名稱
代碼在拆分的過程中呐赡，我們可能會用到一些設(shè)計模式，這時候如果在名字上不體現(xiàn)出來骏融，那么可能看很久才能看懂链嘀。但是只要在命名類、函數(shù)档玻、變量的時候加以區(qū)分怀泊，那么可以讓閱讀代碼的人很快get到代碼整體的組織方式，比如Factory误趴、Facade霹琼、Proxy、Decorator凉当、Command等枣申。
其實很多框架的源碼在書寫過程中也是這樣做的，比如Struts2的RequestFacade看杭、Mybatis的SqlSessionFactory等忠藤。這樣讀者在讀到響應(yīng)的類名的時候就能夠理解這個類的功能。
同樣楼雹，除了設(shè)計模式模孩，我覺得各個目錄下的代碼也應(yīng)該加上對應(yīng)的前綴或后綴尖阔，比如XxxUtils、BaseXxx榨咐、CommonXxx等介却。
總結(jié)
以上，雖然只列了3點块茁，但是主要的思想已經(jīng)表達清楚了齿坷，就是合理的運用一些變量名、函數(shù)名龟劲、類名胃夏、模塊名等轴或，通過見名知意的名字來描述代碼本身昌跌。
