Question

假设，我有一个方法，哪些参数是已定义文档的类：

/// <summary>
///     Get criterion from table.
/// </summary>
/// <param name="plySide"></param>
/// <param name="criterionType"></param>
/// <returns></returns>
public Criterion GetCriterion(PlySide plySide, CriterionType criterionType)
{
   // some code
}

PlySide类拥有自己的xml文档：

/// <summary>
///     Sides of monoply.
/// </summary>
public enum PlySide
{
   // some code
}

正如您在GetCriterion方法中所看到的，我没有为plySide param标记定义任何文档。我的问题是我应该重复一个参数的描述，还是应该删除param标签？

Answer 1

您不应该复制它，而是提供参数的上下文感知描述。在你的情况下它可能是这样的（也许它是非常错的，但我不知道你的方法的实现和意图）：

/// <summary>
///     Get criterion from table.
/// </summary>
/// <param name="plySide">Monopoly side to get criterion for</param>
/// <param name="criterionType">Criterion to get for the given monopoly side</param>
/// <returns></returns>
public Criterion GetCriterion(PlySide plySide, CriterionType criterionType)
{
   // some code
}

Answer 2

PlySide文档将描述类型。

plySide文档应该在GetCriterion方法中描述参数扮演的角色。

那些通常会巧妙地（或不那么微妙地）不同。

C＃方法参数XML文档问题

2 个答案: