C#文档 - 用户定义的标签

Luc*_*uca 4 c# xml documentation

我想记录我的源代码(C#源代码),确实我使用了定义的XML文档标记.我如何通过特定标签定义?

例如,我使用了很多Design by Contract断言.我想要有前提条件,后置条件,不变量的文档部分...应该编写如下文档:

/// <precond>arg != null</precond>
/// <postcond>return > 0</postcond>
Run Code Online (Sandbox Code Playgroud)

既然我不是XML大师,你们(大师)的某个人可以建议我吗?

我尝试使用<include>,但是(对我而言)正确构建文档是不可能的.

非常感谢你

PVi*_*itt 5

首先是对xml注释可行的非常有用的描述.

接下来,生成文档的应用程序必须知道您自己制作的标记.我目前还不知道可以使用其他属性或元素进行扩展的文档构建器.

  • NDoc和Sandcastle都支持扩展标签.NDoc自发布以来一直如此 (2认同)
  • 不确定在提出原始问题后这么长时间是否有用,但这是此响应中页面的最后保存副本(2009年):https://web.archive.org/web/20090604112954/http://thoughtpad .net / alan-dean / cs-xml-documentation.html (2认同)