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

对于methodA（），我想使用/// xml文档系统。我想在methodA（）之前调用methodB（）方法。在xml注释中，我可以标记方法名称，以便它们可以重构吗？

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

我确定我看到了这个地方的例子，所以我认为它是可能的。我该怎么做？

来源

2012-07-12 Isaac Bolinger

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

来源

2012-07-13 07:29:27

当方法重命名时，cref肯定是重构的，但我没有看到警告。也许我是盲人。无论如何，我从这里弄明白了，谢谢。 – 2012-07-13 19:39:48

你真的设置了生成选项来生成xml文档吗？看看第一个截图[here]（http://development.meritsolutions.com/matters/visual -studio-xml-documentation-introduction /） – 2012-07-13 20:41:16

否我没有，你的意思是“XML documentation file：”在项目属性中，对吧？ – 2012-07-14 01:35:33

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

回答

相关问题