C＃方法参数XML文档问题

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标签定义任何文档。 我的问题是我应该重复参数的描述还是应该删除参数标签？

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方法中扮演的GetCriterion 。

这些通常会微妙（或不太微妙）不同。