注釋是無奈的妥協(xié)

在理想的情況下，代碼不需要注釋。理想的代碼，命名恰當(dāng)，結(jié)構(gòu)清晰，邏輯順暢，含義顯而易見。

注釋帶來的三個(gè)麻煩？

1.因?yàn)樽⑨尣恍枰\(yùn)行，所以沒有常規(guī)的辦法來測試它。注釋難以維護(hù)，這是使用注釋帶來最大的麻煩。

2.注釋為我們提供了一個(gè)借口。我們有時(shí)候會過度依賴注釋，從而放棄了潛在的替代方案，比如更準(zhǔn)確的命名，更清晰的結(jié)構(gòu)，更順暢的邏輯等等。注釋，被我們用成了狗皮膏藥，有時(shí)會讓代碼更糟糕。

3.注釋的濫用

幾種常見注釋類型

1.記錄源代碼版權(quán)和授權(quán)的

2.用來生成的用戶文檔的

用來生成獨(dú)立的，不包含源代碼的文檔。這些文檔幫助使用者了解軟件的功能和細(xì)節(jié)，主要面向該軟件的使用者，而不是該軟件的開發(fā)者。

3.解釋源代碼的

幫助代碼的閱讀者理解代碼。

注釋的三項(xiàng)原則

1.周期 ，錯(cuò)誤的注釋比沒有注釋更糟糕

2.必要，多余的注釋浪費(fèi)閱讀者時(shí)間

3.清晰 混亂的注釋會把代碼搞得更亂

注釋用英文還是中文？

推薦英文注釋，在國際化項(xiàng)目中，沒有辦法使用中文。

https://time.geekbang.org/column/article/78086