Eric 分享
12 years ago
從閱讀者心出發的註解寫作 via 程式者的胡言亂語
latest #8
Eric
12 years ago
程式碼註解應該用來解釋「程式碼為什麼要這麼寫」,而不是「程式碼究竟寫些什麼」
Eric
12 years ago
註解是在補充程式碼的不足之處,所以程式碼和註解有點互補的關係
Eric
12 years ago
能自我說明(self-documented)的程式碼正是一種具有高說明力的程式碼
立即下載
Eric
12 years ago
而註解存在的需要性,也就因為良好的命名而消除
Eric
12 years ago
應該盡可能的先提昇程式碼的品質,接著才是輪到註解登場的時機
Eric
12 years ago
撰寫註解時,有一個很重要的態度便是要站在讀者的立場上來寫
Eric
12 years ago
當你修改你的程式碼時,請千萬要記得同步修改你的註解,使這二者隨時保持一致
Eric
12 years ago
重點不在於寫下多少註解,而是在於註解與程式碼是否能相搭配。好的註解就和好程式碼一樣,不僅形式一致而且清晰。好的註解從閱讀者的立場切入,並且切合閱讀者的心。
back to top