.Net XML文档标准

我已看过建议的相关问题，但它们都不是我正在寻找的。作为一名新开发人员，我正在努力遵循最佳实践，并且文档很大。我一直在尝试在我的代码中创建XML文档。我发现了GhostDoc插件可以帮助加快速度。.Net XML文档标准

虽然我的问题是;对于应包含在XML中的内容，是否有一个通常除外的标准？默认情况下，我在适用时使用<Summary><Param><Returns>。有其他人吗？我应该包括作者吗？怎么样？ <Patrick></Patrick>？ <Remarks>是值得的时间？

我将不胜感激这方面的任何指导。谢谢！

来源

2009-02-11 Refracted Paladin

我最近才发现this guide to XML documentation。这是真的方便。这不是最佳实践指南，但它很好地覆盖了不经常使用并因此被遗忘的标签。

来源

2009-02-11 18:52:29

此链接已死亡。 – 2010-06-07 20:50:01

我绝对认为<remarks>标签是值得的，因为它允许您详细说明摘要，更多的知识总是一件好事。

我也认为<typeparamref>对泛型类很重要。

在每个元素中，还应该使用<see>标记，以便您可以将文档链接在一起。

除了标准标签之外，我还添加了<author>以显示类/方法/属性/ etc等的原创作者以及<created>标签，以指示何时创建该成员。在团队环境中，你可能会想要的东西更强大的，就像这样：

<revisions> 
    <revision> 
    <author>Nicholas Paldino</author> 
    <revised>2009-02-01</revised> 
    </revision> 
    <revision> 
    <author>Mr_Mom</author> 
    <revised>2009-02-11</revised> 
    </revision> 
</revisions>

来源

2009-02-11 18:32:59 casperOne

@casperOne：我想我会找到所有这些阻碍。这就是源代码控制的作用......它更可能是一致和准确的，并且不会混淆代码。 – 2009-02-12 19:11:06

.Net XML文档标准

回答

相关问题