Microsoft拥有三斜杠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) { /* ... */ }
现在,我仅假设<summary>
标签始终应该是第一个标签。
在GitHub上浏览源代码后,一种模式开始出现,并且以下非正式的标签顺序似乎很常见:
summary
typeparam
param
returns
exception
remarks
example
其他观察:
true
,false
并且null
往往是在包裹内的<c>
标签。<c>
标记中。<see cref="Foo"/>
标签标记。<see cref="Bar{T}"/>
标签标记。<paramref name="name"/>
标签标记。<typeparamref name="T"/>
。<code>
内的标记)<example>
有时会缩进。本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句