在编写xml文档时,如何在方法摘要中引用方法参数?

时间:2015-05-15 08:38:56

标签: c# visual-studio sandcastle xml-documentation

假设我有一个方法如下:

    /// <summary>
    /// Here I want to reference the parameter <see cref="personId"/>.
    /// </summary>
    /// <param name="personId">
    /// The person id.
    /// </param>
    /// <returns>
    /// The <see cref="Person"/>.
    /// </returns>
    public Person GetPerson(int personId)
    {

    }

当我使用sandcastle发布我的xml文档时,cref:

<see cref="personId"/>

转换为 [!: personId]

Sandcastle的警告是:

&#39;未知参考链接目标&#39;

有什么建议吗? 感谢。

1 个答案:

答案 0 :(得分:16)

使用<paramref>

<paramref name="personId"/>