Comment autocorriger la documentation xml des méthodes

Dans le document ci-dessous dans les documentations XML, il existe une discordance 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.Comment autocorriger la documentation xml des méthodes

#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

Source

2009-09-19 Raghav

Après l'installation, vous obtenez un nouvel élément de menu contextuel dans VS 'Document this' (et un raccourci clavier correspondant).

Si aucun commentaire XML n'est présent, il les ajoutera. S'ils sont déjà présents, ils devraient être mis à jour selon vos besoins.

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

Source

2009-09-19 15:42:37

Comment sait-il que la documentation xml doit être corrigé et les arguments de la fonction? – Vadim

Il examine les éléments params, les compare aux arguments et les mises à jour si nécessaire. J'ai essayé un exemple, ça marche bien. –

Merci, Adam cela fonctionne bien une chose de plus, actuellement avec cette fonctionnalité je dois aller à chaque méthode et appuyez sur CTRL + Shift + D pour exécuter la documentation xml.Is-il moyen de corriger la documentation xml toutes les méthodes dans un fichier de classe? – Raghav

La seule façon que je sais xml "auto correct" avec R # est de supprimer la documentation xml existante et appuyez sur/// encore. Désolé je n'ai pas une meilleure réponse.

Je crois que ce n'est pas possible car R # n'a pas besoin de corriger la documentation xml ou la signature de méthode. GhostDoc fera cela pour vous.

Source

2009-09-19 15:39:42 Vadim

Comment autocorriger la documentation xml des méthodes

Répondre

Questions connexes