【问题标题】:How can I reference a constructor from C# XML comment?如何从 C# XML 注释中引用构造函数?
【发布时间】:2010-11-10 14:02:11
【问题描述】:

是否可以在不使用显式前缀(如 M: 或 T:)的情况下从 C# XML 注释中引用构造函数?

例如,以下会产生编译警告,因为编译器不喜欢“.ctor”。尝试“PublishDynamicComponentAttribute.#ctor”不好,
“PublishDynamicComponentAttribute.PublishDynamicComponentAttribute”也不好。

/// <summary>
/// Constructs a new <see cref="PublishEntityAttribute"/> instance.
/// </summary>
/// <seealso cref="PublishDynamicComponentAttribute..ctor(Type)"/>
public PublishEntityAttribute(Type entityFactoryType) :
  base(entityFactoryType)
{
}

我确定类型本身是可见的。

所以,我只能使用显式前缀 M:,它会删除编译器验证,因此当类型被移动/重命名时,cref 将无效。

有什么建议吗?

【问题讨论】:

    标签: c# xml constructor comments


    【解决方案1】:

    你指定一个构造函数,就像你在调用它一样,但是使用参数的类型而不是它们的值:

    /// <seealso cref="PublishDynamicComponentAttribute(Type)"/>
    

    【讨论】:

    • 这绝对正确吗? Resharper 7.0 警告“'' 的签名不正确”,其“显示快速文档”命令将其视为类链接。
    • @Iain:它适用于我的 R# 7.0,包括链接到构造函数而不是类。
    • 很奇怪,我肯定收到了警告。也许启用了不同的检查,也许是 R# 错误修复......
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2016-01-07
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2010-11-27
    • 1970-01-01
    相关资源
    最近更新 更多