特殊的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＃源代码文档示例

回答

相关问题