2010-03-04 65 views
0

在這樣的代碼中寫評論是否有意義?爲每個類成員編寫一個類的成員類型是否有意義?

/// <Remarks> 
/// Name of abc - public property. 
/// </Remarks> 

在Visual Studio,智能感知對每種類型的類成員(字段,屬性等)的圖標,所以我沒有看到這一點。在我目前的商店中,我們只使用Visual Studio,它提供了這些圖標。

謝謝

+0

DRY,YAGNI。(不完全是DRY,但*非常接近並且具有相同的精神)。 – 2010-03-05 00:05:47

回答

1

似乎對我來說毫無用處。我會避免它,因爲正如你所說,這是可以從代碼推斷出來的東西。 (編輯:FWIW,也許它對於你的組織運行的某些工具來做文檔很有用,而且這個工具還不夠聰明,無法檢測屬性與字段,但我懷疑是這樣的,不過,這是一個潛在的原因編碼'冗餘'的數據到註釋中(以滿足一個工具(人類與否:P))。

+0

這是一個爲什麼我的笑聲是一個經驗較少(年齡較小 - 較少工作經驗)的編碼員在評論他的代碼的時候是否真的應該是他自己的責任?xml評論不會被執行到所以我說的文件會很好,真的很奇怪。 – dotnetdev 2010-03-04 23:11:58

相關問題