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

Question

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

假设有人将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：我假设“构建 Xml 文档”选项在项目属性中已激活，但如果您问过这样的问题，我相信它是激活的。