在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註釋中，我可以標記方法名稱，以便它們可以重構嗎？

回答

相關問題