如何在Obsolete特性中避免魔法字符串并关联新类？

AI 小北

2026-6-17

解决Obsolete特性中成员引用的IDE导航与重命名同步问题

目前.NET的ObsoleteAttribute确实不支持直接在提示文本中嵌入可导航的成员引用，但可以通过以下折中方案解决重命名同步和部分导航需求：

1. 用`nameof()`避免魔法字符串，保证重命名同步

虽然无法实现Ctrl+Click跳转，但nameof()关键字可以确保重命名目标成员时，Obsolete提示中的名称自动同步更新，彻底解决硬编码字符串的维护问题：

// 标记旧属性为过时
[Obsolete($"该属性已过时，请使用 {nameof(NewProperty)} 替代", false)]
public static string OldProperty
{
    get { return "旧属性值"; }
}

public static string NewProperty
{
    get { return "新属性值"; }
}

2. 结合XML文档注释实现可跳转引用

如果需要保留IDE导航能力，可以将XML注释的<see cref=""/>标签与Obsolete特性结合：

/// <remarks>已被 <see cref="NewProperty"/> 替代</remarks>
[Obsolete($"该属性已过时，请使用 {nameof(NewProperty)} 替代", false)]
public static string OldProperty
{
    get { return "旧属性值"; }
}

public static string NewProperty
{
    get { return "新属性值"; }
}

用户可以通过鼠标悬停查看XML注释，再通过Ctrl+Click``<see cref=""/>中的成员实现跳转，同时Obsolete提示的名称也能随重命名自动更新。