C# XML文档中标记的排序

微软有三斜杠XML文档和他们的

如果标签在不同的地方使用的顺序不同，那就很奇怪了

因此，我想知道是否有任何推荐的XML标记顺序

例如：

/// <summary>Performs a foo calculation.</summary>
/// <param name="baseValue">The base value.</param>
/// <param name="af">The amplification factor.</param>
/// <returns>The supposed calculation.</returns>
/// <exception cref="ArgumentException"><paramref name="af"/> is negative.</exception>
/// <remarks>According to the theory laid forward by Dr. Hans Foo in 1732.</remarks>
/// <example>
/// Performs a foo calculation using a amplification factor of 10.
/// <code>var value = Foo(512, 10);</code>
/// </example>
public decimal Foo(int baseValue, decimal af) { /* ... */ }

---

现在，我只假设

标记始终应该是第一个标记。

这些内联文档语句（cf.）生成的XML文档似乎没有正式的XML模式，因此，最好的答案可能是，顺序是否起作用取决于您想对XML文档做什么。据我所知，大多数文档生成器不会对顺序产生影响，IntelliSense也不会

除了技术上的后果，我同意遵守一些代码准则可能会有帮助，但我也没有听说过一个被广泛接受的准则

因此，简而言之，我认为没有推荐的顺序，因为顺序不会产生任何影响，但您可以自由创建内部指南。

浏览之后，一种模式开始出现，以下非正式的标记顺序似乎很常见：

摘要

typeparam

param

返回

例外情况

备注

示例

其他意见：

• 单词

  true

  、

  false

  和

  null

  往往被包装在
  标记中
• 有时但并非总是URL位于
  标记内
• 对类型的引用用
  标记
• 泛型类型的引用用
  标记
• 对参数的引用用
  标记标记
• 泛型类型参数的引用用
  标记标记
• 句子以标点符号结尾
• 嵌套标记，例如
  中的
  ，有时会缩进

---

它们的主要用途是作为VisualStudio获取的元数据，以提供更好的intellisense帮助，因此在正常使用情况下，顺序并不重要。显然，在代码库中，您可能会关心。也许您可以在内部对GhostDoc的工作进行标准化：