c# - 编写 XML 文档时如何在方法摘要中引用方法参数?

标签 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 中的警告是:

Unknown reference link target

有什么建议吗?

最佳答案

使用 <paramref>

<paramref name="personId"/>

关于c# - 编写 XML 文档时如何在方法摘要中引用方法参数?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/30255085/

相关文章:

c++ - 在 Visual Studio 2012 中以管理员身份调试 Visual C++ 应用程序

c# - 用于重新格式化文本的免费 Visual-studio 插件

visual-studio - .Net XML注释到API文档中

html - 使用 SandcaSTLes 在 CHM 帮助文件中嵌入图像

c# - 将 C 中的指针转换为 C#

c# - 模型值在回发期间丢失

c# - WCF 已超出传入消息的最大消息大小配额 (65536)

c# - 在使用 CaSTLe Windsor IoC 容器注册组件期间设置 Name 属性

c++ - 在 VS2005 的链接过程中合并元数据时忽略文件

可打印形式的 C# 类文档