2009-09-19 25 views
0

在以下xml文檔中的代碼中,方法參數中的參數名稱與xml文檔中的參數名稱之間存在不匹配。有什麼方法可以自動更正XML文檔簽名或resharper中提供的任何功能來自動更正xml文檔。如何自動更正方法的xml文檔

#region Get Images 

/// <summary> 
/// Get Images 
/// </summary> 
/// <param name="par1"></param> 
/// <param name="par2"></param> 
/// <returns></returns> 
public Collection<UserImage> GetImages() 
{ 
    return GetImages(""); 
} 

/// <summary> 
/// Get Images 
/// </summary> 
/// <param name="par1"></param> 
/// <param name="par2"></param> 
/// <returns></returns> 
public Collection<UserImage> GetImages(string imageType) 
{ 
    return GetImages(0, imageType); 
} 

/// <summary> 
/// Get Images 
/// </summary> 
/// <param name="par1"></param> 
/// <param name="par2"></param> 
/// <returns></returns> 
public Collection<UserImage> GetImages(int imageId) 
{ 
    return GetImages(imageId, ""); 
} 

/// <summary> 
/// Get Images 
/// </summary> 
/// <param name="par1"></param> 
/// <param name="par2"></param> 
/// <returns></returns> 
public Collection<UserImage> GetImages(int imageId,string imageType) 
{ 
    return null; 
} 

#endregion 

比如我想使用XML文檔這樣的方法:

/// <summary> 
/// Get Images 
/// </summary> 
/// <param name="imageId"></param> 
/// <param name="imageType"></param> 
/// <returns></returns> 
public Collection<UserImage> GetImages(int imageId,string imageType) 
{ 
    return null; 
} 

#endregion 

回答

6

GhostDoc將爲您做到這一點。安裝完成後,你會在VS'Document this'中獲得一個新的上下文菜單項(以及相應的鍵盤快捷鍵)。

如果不存在XML註釋,它將添加它們。如果它們已經存在,它們應該根據需要更新。

http://submain.com/products/ghostdoc.aspx

+0

它如何知道xml文檔需要更正以及函數中的參數? – Vadim 2009-09-19 15:44:19

+0

它會查看params元素,並根據需要將它們與參數和更新進行比較。我試過一個例子,它運作良好。 – 2009-09-19 15:45:35

+0

謝謝,亞當它更好地工作一件事,目前與該功能,我必須去每種方法,並按CTRL + Shift + D執行XML文檔。是否有方法來糾正XML文檔類文件中的所有方法? – Raghav 2009-09-19 18:26:35

1

我知道只有這樣,才能「自動更正」 XML與R#爲刪除現有的XML文檔和命中/ //再次。對不起,我沒有更好的答案。

我相信這是不可能的,因爲R#不需要更正xml文檔或方法簽名。