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

发布时间：2020-12-16 01:32:00 所属栏目：百科来源：网络整理

导读：我想记录我的源代码(C#源代码),确实我使用了定义的 XML文档标记.我如何通过特定标签定义？例如,我使用了很多Design by Contract断言.我想要文档部分对于先决条件,后置条件,不变量…… 编写如下文档应该是很容易的： /// precondarg != null/precond/// pos

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

例如,我使用了很多Design by Contract断言.我想要文档部分
对于先决条件,后置条件,不变量……
编写如下文档应该是很容易的：

/// <precond>arg != null</precond>
/// <postcond>return > 0</postcond>

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

我试过用<包括>,但是(对我来说)正确构建文档是不可能的.

非常感谢你

解决方法

使用 NDoc构建文档及其 custom tags可能是一个解决方案. NDoc的一个问题是开发停止了一段时间.

Sandcastle also supports custom tags,我不确定这是否适用于Sandcastle Builder,如果这是一个问题.

两者都是通过自定义默认XSL用于其变换来完成的,例如,

<xsl:template match="myTag" mode="seealso-section">
    <h1 class="green">
         <xsl:value-of select="." mode="slashdoc"/>
    </h1>
    </xsl:template>     
    <xsl:template match="null" mode="slashdoc">
    <xsl:text> null reference (Nothing in Visual Basic) </xsl:text>
</xsl:template>

由编译器构建的XML(csc.exe / doc)没有在标记中强制使用名称空间,因此您可以自由使用您喜欢的任何标记.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!