c# – 从代码中分离文档

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了c# – 从代码中分离文档，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含1198字，纯文字阅读大概需要2分钟。

内容图文

我不知道是否可能,但我想知道是否有办法将代码和文档保存在单独的文件中,但仍然与通常使用内联文档相同.

解决方法:

是的,您可以将XML文档注释保留在外部文件中,并使用< include>将它们包含在代码文件中.标签.

从the MSDN documentation开始：

The tag lets you refer to comments in another file that describe the types and members in your source code. This is an alternative to placing documentation comments directly in your source code file. By putting the documentation in a separate file, you can apply source control to the documentation separately from the source code. One person can have the source code file checked out and someone else can have the documentation file checked out.

例如,您可能有一个名为xml_include_tag.doc的文件,其中包含以下文档注释：

<MyDocs>

    <MyMembers name="test">
        <summary>
            The summary for this type.
        </summary>
    </MyMembers>

    <MyMembers name="test2">
        <summary>
            The summary for this other type.
        </summary>
    </MyMembers>

</MyDocs>

您可以在代码文件中包含此文档,如下所示：

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
class Test
{
    static void Main()
    {
    }
}

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
class Test2
{
    public void Test()
    {
    }
}

内容总结

以上是互联网集市为您收集整理的c# – 从代码中分离文档全部内容，希望文章能够帮你解决c# – 从代码中分离文档所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端