C＃代码的自定义文档

Question

C＃是否有可自定义的文档生成器？与提供类，方法，属性的文档的本机xml文档相反，我在这里引用的文档更低级，即它记录了方法的流程。

例如在给定代码中

void SomeMethod(){

///doc:Do X
SomeCodeToDoX

///doc:Do Y
SomeCodeToDoY

///not tagged
SomeCode

}

文档将捕获doc：Do X和doc：Do Y，并将Do X和Do Y记录为方法SomeMethod中的流程

**我希望我的问题足够清楚......如果我没有请求评论澄清*

Answer 1

据我所知，您可以在文档注释中使用您喜欢的任何XML元素 - 但它们必须附加到成员;你不能只是在一个方法的代码中添加doc注释，我担心。

或者至少，你可以，但它不会被作为生成的XML文件的一部分被接收，你会收到这样的警告：

  

Test.cs（11,9）：警告CS1587：XML注释未放在有效的语言元素上

可能如果您禁用该警告并使用Doxygen处理源代码而不是内置生成器，那么<​​em>可能能够获得一些信息。但是你应该知道它将非常特定于你的环境。我怀疑，这些好处不值得痛苦，我自己。我还会对有大量注释的代码的可读性发出警告 - 如果你真的只想查看代码本身就会分散注意力。

（出于某种原因，当我尝试发布Doxygen的链接时，SO正在bar ...将在Meta上提交错误。）

Answer 2

不知道这是否能回答您的问题，但您可以使用SandCastle：http://sandcastle.codeplex.com/

它通过反映程序集创建MSDN文档。您也可以（但不是必须）添加自己的文档标签。