你見過哪些奇葩的代碼注釋，最後那個回復神了！

今天給大家分享一些有趣的代碼注釋，最後一個回復神了！

一般來說，我覺得比較完整的注釋是：

1.如果你的代碼是開源供很多人用的，最好在入口檔的前面，或者是專門有一個readme檔來說明你整個專案的基本結構和功能。

2.如果方便的話，最後給出一個demo來供別人參考

3.方法/類注釋一般來說我會要求寫方法和類的人，在每一個方法/類前面寫上方法的功能，傳入參數和含義，返回的資料結構和含義，方法的作者以及聯繫郵箱和寫入時間。

4.之後每次修改，都要在注釋後面寫上修改者的姓名郵箱時間和修改原因以及修改內容的簡要說明

這裡還是要推薦下我自己建的前端學習群：659247717，

如果你正在學習前端，小編歡迎你加入，大家都是前端黨，不定期分享乾貨（只有web前端相關的），包括我自己整理的一份2017最新的前端資料和零基礎入門教程，歡迎初學和進階中的小夥伴。

最後在對程式師提點建議：

大段大段的代碼注釋是維護者的噩夢。

所有可維護的代碼遵守的都是一個原則:降低維護時所需要載入的工作記憶量。

由於人是有生理局限性的，

因此越少的記憶量就代表著越好的可維護性。大量的記憶很容易出錯而且學習成本很高。代碼結構清晰，不必要的東西儘量少，採用有意義的命名等，都是基於同一個原則。而閱讀者看你的代碼，需要越過注釋代碼的崇山峻嶺，這顯然是不合適的。而且也還混淆了有意義的注釋和沒有意義的注釋(代碼注釋）==我理解你刪除代碼的困難。不敢刪除代碼，說明專案缺少合適的手段保證正確性。業內經常使用的方法是單元測試。這個可以讓你對代碼的品質有一個基本的保證，也可以確認重構沒有破壞什麼東西。害怕以後有用，說明專案沒有合適的版本控制系統。版本控制就是幹這個用的，若是想回退到某個版本，或者撤銷某個版本的修改，一兩句命令就能搞定。而且提交資訊本身就說明了是什麼修改，不需要你記憶。

這個話題到這裡就算是做完了，我自己也是一名前端程式師，建了一個新群每天分享對應的學習資料：659247717，歡迎初學和進階中的小夥伴。

如果想看到更加系統的文章和學習方法經驗可以關注我的微信公眾號：‘web前端課程’關注後回復‘給我資料’可以領取一套完整的學習視頻說明專案缺少合適的手段保證正確性。業內經常使用的方法是單元測試。這個可以讓你對代碼的品質有一個基本的保證，也可以確認重構沒有破壞什麼東西。害怕以後有用，說明專案沒有合適的版本控制系統。版本控制就是幹這個用的，若是想回退到某個版本，或者撤銷某個版本的修改，一兩句命令就能搞定。而且提交資訊本身就說明了是什麼修改，不需要你記憶。

這個話題到這裡就算是做完了，我自己也是一名前端程式師，建了一個新群每天分享對應的學習資料：659247717，歡迎初學和進階中的小夥伴。

如果想看到更加系統的文章和學習方法經驗可以關注我的微信公眾號：‘web前端課程’關注後回復‘給我資料’可以領取一套完整的學習視頻