假设,我有一个方法,其参数是具有已定义文档的类:
/// <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 标签定义任何文档。我的问题是我应该重复参数的描述还是应该删除参数标签?
该PlySide
文档将描述类型是什么。
该plySide
文件应说明什么角色参数扮演的内GetCriterion
法。
这些通常会微妙地(或不那么微妙地)不同。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句