Question

Dans le code ci-dessous dans xml il documentation non-concordance entre les noms des paramètres dans les arguments de la méthode et le nom des paramètres dans la documentation xml. Est-il possible de corriger automatiquement la signature de la documentation xml ou toute fonctionnalité fournie dans ReSharper pour corriger automatiquement la documentation 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

Par exemple, je veux la méthode avec la documentation xml comme ceci:

/// <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
Était-ce utile?

La solution

GhostDoc fera pour vous. Après l'installation, vous obtenez un nouvel élément de menu contextuel dans « document ce » VS (et un raccourci clavier correspondant).

Si aucun commentaire XML sont présents, il les ajoutera. Si elles sont déjà présentes, ils devraient obtenir mis à jour que vous avez besoin.

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

Autres conseils

La seule façon que je connaisse « auto correct » xml avec R # est de supprimer la documentation xml existante et cliquez sur /// nouveau. Désolé, je n'ai pas une meilleure réponse.

Je crois qu'il est impossible parce que R # ne pas ce besoin de corriger la signature de la documentation xml ou méthode.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top