我的代码包含一个带有一个方法的类,该方法返回一个最初作为参数传递给另一个方法的对象。我想在XML文档标记中指出这种关系。
class XmlDocThing
{
/// <summary>
/// Documentation for the other method.
/// </summary>
/// <param name="howDoIReferToThis">Magic object.</param>
public void AnotherMethod(object howDoIReferToThis) { }
/// <summary>
/// Documentation for this method.
/// </summary>
/// <returns>The object passed as the <paramref name="howDoIReferToThis"/>
/// argument of the <see cref="AnotherMethod"/> method.</returns>
public object FromThisMethod() { return null; }
}
这会产生警告:
警告1对“MyNamespace.XmlDocThing.FromThisMethod()”的XML评论 有'howDoIReferToThis'的paramref标签,但没有参数 以那个名字
执行方法引用的<see cref="AnotherMethod"/>
元素按预期工作,但<paramref>
似乎没有cref
属性(似乎只适用于方法和属性成员) ),或任何等价物。
这是否可能,如果是,怎么样?