Comment utiliser les commentaires en ligne pour documenter des membres dans .NET?

Question

Comment documenter un membre en ligne dans .Net? Laisse-moi expliquer. La plupart des outils qui extraient la documentation des commentaires prennent en charge une sorte de documentation en ligne dans laquelle vous pouvez ajouter un résumé après la déclaration du membre. Quelque chose comme:

public static string MyField; /// <summary>Information about MyField.</summary> 

Existe-t-il un moyen de le faire en C# ou dans les langages .NET?

Answer 1

Non, vous ne pouvez pas. Les commentaires XML sont uniquement pris en charge en tant que commentaire de niveau bloc, ce qui signifie qu'ils doivent être placés avant l'élément de code que vous documentez. Les outils communs pour extraire les commentaires XML du code .NET ne comprennent pas comment analyser les commentaires en ligne comme ça. Si vous avez besoin de cette capacité, vous devrez écrire votre propre analyseur.

Answer 2

Eh oui, vient de mettre avant la chose que vous voulez faire des commentaires

/// <summary>Information about MyField.</summary> 
public static string MyField; 

Answer 3

Il n'existe pas de méthode intégrée pour ce faire. Le système de documentation XML est hiérarchique; il définit une relation entre l'étiquette <summary /> et les données qui la suivent immédiatement.