阿里架構師淺析體面編碼之代碼註釋評論

避免無意義的註釋評論，不添加任何價值。如果通過閱讀代碼可以清楚地看到某些內容，則評論只會增加噪音。 考慮是否可以改進代碼，以便不再需要註釋。通過改進命名，重構（例如，提取函數）或引入解釋變量，通常可以解釋解釋代碼正在做什麼以及有時爲什麼的註釋。 考慮一個單元測試是否會更好的溝通。構造良好和命名的單元測試可以解釋代碼背後的原因，以及在不同情況下演示和驗證其行爲。 解釋從代碼中不清楚的推理。預計未來的

>>阅读原文<<