Question

在下面的xml文档代码中，方法参数中的参数名称与xml文档中的参数名称不匹配。有没有办法自动更正xml文档签名或resharper中提供的任何功能来自动更正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

Answer 1

GhostDoc会为你做这件事。安装完成后，您将在VS'Document this'（以及相应的键盘快捷键）中获得一个新的上下文菜单项。

如果没有XML注释，它将添加它们。如果它们已经存在，则应根据需要进行更新。

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

Answer 2

我知道使用R＃“自动更正”xml的唯一方法是删除现有的xml文档并再次点击///。对不起，我没有更好的答案。

我认为这是不可能的，因为R＃不需要更正xml文档或方法签名。

如何自动更正方法的xml文档

2 个答案: