Pregunta

En el siguiente código XML en documentaciones existe falta de correspondencia entre los nombres de los parámetros en los argumentos del método y el nombre de los parámetros en la documentación XML. ¿Hay alguna manera de corregir la firma de automóviles documentación XML o cualquier característica proporcionada en ReSharper para auto corregir la documentación 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

Por ejemplo quiero que el método con la documentación XML siguiente:

/// <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
¿Fue útil?

Solución

GhostDoc lo hará por ti. Después de la instalación se obtiene un nuevo elemento de menú contextual en el 'Documento de esta' VS (y un atajo de teclado correspondiente).

Si no hay comentarios XML están presentes, los añadiremos. Si ya están presentes, deben se actualizan como sea necesario.

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

Otros consejos

La única forma que conozco de "corrección automática" xml con R # es eliminar la documentación XML existente y pulsa /// nuevo. Lo siento, no tengo una respuesta mejor.

Creo que no es posible porque R # no hace lo necesario para corregir la documentación XML o método de firma.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top