Documentation

Documentation .Net

Écrit par Pascal Bangerter

Index de l'article

But

Les classes.NET peuvent être documentées en incluant des balises XML

 

Chaque Classe, Méthode, Structure, Enumération, etc. peut être documentée par des balises XML.
Dans Visual Studio pour insérer ce type de commentaire, il suffit de taper trois slash /// (deux apostrophe '' en VB.Net) juste au dessus de l'élément à documenter et un squelette de commentaire apparait

/// <summary>;
///
/// </summary>
private void MaMethode()
{
}

 

Selon le contenu de l'élément à documenter le squellete peut contenir plus ou moins d'informations.

/// <summary>
/// 
/// </summary>
/// <param name="param1"></param>
/// <param name="param2"></param>
/// <returns></returns>
private int MaMethode(int param1, int param2)
{ 
 return 0;
}

 

Pour avoir plus d'informations sur ce type de documentation voir "Commentaires de documentation XML" dans la Bibliographie

Documenter son code c'est bien, mais si ces commentaires peuvent-être utilisés pour générer une documentation ou pour nous aider dans la suite de notre travail c'est encore mieux.

Dans les propriétés du projet de votre application, section "Build" - "Output",



si vous cochez "XML documentation file" et que vous donnez un nom de fichier XML, ces balises XML seront utilisées pour générer l'aide de vos Classes via "IntelliSense" ainsi qu'une documentation au format XML.

Aide au développement grace à Intelisense