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：我认为在项目属性中激活了Build Xml文档选项，但我确信如果你问过这样的问题。

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

1 个答案: