c# - 在 xml 注释中，我可以标记方法名称以便它们可重构吗？

Question

对于 methodA()，我想使用///xml 文档系统。我想证明应该在 methodA() 之前调用 methodB()。

假设有人将 methodB() 重命名为 renamedMethodB()，我希望将注释中的旧 methodB() 引用更新为 renamedMethodB()。假设有人删除了 methodB()(并假设没有其他人使用 methodB())，我希望程序不编译，或者至少根据 methodB() 注释生成警告，然后引用一个不再存在的方法.

我肯定我在某个地方看到过这样的例子，所以我认为这是可能的。我该怎么做？

Answer 1

如果用户使用 Visual Studio 的重构菜单，他将可以选择在字符串和注释中搜索方法。如果他不这样做，则没有选项可以自动执行此操作。

为了降低丢失重命名的风险，请始终使用 <see cref="OtherMethod"/>在您的评论中构建。如果无法解析方法名称，则会产生警告。

示例:

/// <summary>
/// This method will call <see cref="MethodB"/>
/// </summary>
public void MethodA()
{
    MethodBNew();
}

/// <summary>
/// Some method
/// </summary>
public void MethodBNew() // Formerly MethodB
{
}

此代码将产生警告。

PS:我假设在项目属性中激活了 Build Xml 文档选项，但我相信如果你问过这样的问题，它就是激活的。