我習慣於在我通常是唯一貢獻者的小型項目上工作,但現在我正在開發一個ASP .Net C#項目,其他人將使用我的代碼稍後的。ASP .Net項目中的代碼註釋
我相信我會用專業的方式評論我的C#代碼,但是我從來沒有在我的ASPX頁面中寫過評論,除了JavaScript代碼。
ASP.Net開發人員可以使用任何「標準」嗎?
我是否會在代碼隱藏中爲了簡化閱讀頁面中生成的操作提供有關注釋的信息,或者是過度殺傷?
感謝, 斯特凡
我習慣於在我通常是唯一貢獻者的小型項目上工作,但現在我正在開發一個ASP .Net C#項目,其他人將使用我的代碼稍後的。ASP .Net項目中的代碼註釋
我相信我會用專業的方式評論我的C#代碼,但是我從來沒有在我的ASPX頁面中寫過評論,除了JavaScript代碼。
ASP.Net開發人員可以使用任何「標準」嗎?
我是否會在代碼隱藏中爲了簡化閱讀頁面中生成的操作提供有關注釋的信息,或者是過度殺傷?
感謝, 斯特凡
爭取自記錄代碼(需要更少的評論)。
遵循共同的模式(內部或行業)
解釋不明顯代碼「高層意圖的」使用(謹慎)的意見。
瞭解什麼是(可能)需要解釋如果由其他人查看。使用GhostDoc插件可以快速寫出評論,但請記住驗證由插件編寫的評論。評論應該是自我解釋。
而不是「非明顯的代碼」我會用:抽象的概念和算法。我的意思是你想要記錄不會改變的事情,以及你實際在做什麼,而不是代碼的作用。該代碼告訴你它做了什麼,評論告訴你你想要它做什麼,不應該改變。 – 2011-01-06 10:50:36
@Tomas Jansson:是的,這就是我的意思。注意到並更新。 Thx – 2011-01-06 10:52:41