技術翻譯 - 編寫程式註解的最佳實踐

著名的麻省理工學院教授 Hal Abelson 說：「必須編寫程式供人們閱讀，而只是偶然的也供機器執行。」雖然這句話可能會當作故意低估了運行程式碼的重要性，但他發現程式碼有兩種截然不同的受眾。編譯器和解釋器會忽略註解並發現所有語法正確的程式同樣容易理解。人類來閱讀則是非常不同的。我們發現有些程式比其他程式更難理解，我們希望通過註解來幫助我們理解它們。 我們有許多的資料來幫助工程師寫出更好的程式碼（例如書籍或靜態掃描），但卻很少在說明如何寫更好的註解。雖然衡量程式中註解的數量很容易，但很難衡量質量...