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 文档选项，但我相信如果你问过这样的问题。