代碼整潔之道(二)優雅註釋之道

雲棲君導讀:本文先總結了註釋在編程中的最佳實踐場景並舉例進行了說明,而後就不一樣編程語言提供了一些註釋模版及規範相關的實踐tips。html 1、Best Practice 1.註釋應該聲明代碼的高層次意圖,而非明顯的細節 反例前端 說明java 上文方法用於根據參數生成簽名,註釋中詳細描述了簽名算法的實現步驟,這其實就是過分描述代碼明顯細節算法 正例編程 總結api 註釋必定是表達代碼以外的東西
相關文章
相關標籤/搜索