特殊的C＃源代碼文檔示例

我在想，C＃項目有哪些具有特殊源代碼級文檔的示例？特殊的C＃源代碼文檔示例

謝謝。

2011-05-11 Nick Carlson

** [此BitStream類]（http://www.codeproject.com/KB/cs/bitstream.aspx）**包含足夠的XML註釋，以便整個文檔幫助文件可以直接從源生成。它還包含一個示例應用程序，清楚地說明該類如何工作以及如何使用它。 – 2011-05-11 19:42:10

Telerik通常非常好地記錄他們的代碼。看看他們的MVC extensions project on Codeplex親自看看。

來源

2011-05-11 19:40:38

該項目中的大部分源文件完全沒有記錄。 – 2011-05-11 19:48:49

出色的文檔是一種主觀的東西。

我認爲，專注於編寫清晰，簡潔，可讀的代碼，並且只記錄代碼的業務目的（目的不明確）而不是擔心良好的文檔要好得多。

實際上，文檔很少能跟上代碼更改。（至少以我的經驗）

來源

2011-05-11 19:41:50 David

自我記錄代碼有點神話。確實，類可以是自我描述的，但是類之間的關係（以及這些類的適當的使用場景）並不總是如此明顯。這是文檔在黃金價值中的重要位置。如果這不是真的，那麼微軟會簡單地發佈它的.NET框架，而不用爲它編寫任何文檔或代碼示例。 – 2011-05-11 19:44:43

我希望除非文檔反映這些更改，否則不會進行代碼更改。 – 2011-05-11 19:46:27

@羅伯特哈維 - 我想我必須同意。我主要考慮內部代碼評論作爲所描述的問題。我忘記了編寫API的公司傾向於使用C＃和VB.NET中的XML註釋功能（技術上的代碼註釋）來創建外部文檔。我們的大部分外部文檔來自代碼註釋以外的其他來源，因此對我來說它們是不同的實體，並且我們確保我們的外部文檔保持最新。我們的開發流程包括文檔審覈以及代碼審覈以確保這一點。 – David 2011-05-11 20:43:45

特殊的C＃源代碼文檔示例

回答

相關問題