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

Question

Comment puis-je documenter un membre en ligne en .Net ? Laissez-moi vous expliquer. La plupart des outils qui extraient la documentation des commentaires supportent une sorte de documentation en ligne où vous pouvez ajouter une brève 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 faire cela en C# ou dans les langages .NET ?

Answer 1

Non, tu ne peux pas. Les commentaires XML ne sont pris en charge qu'en tant que commentaires de niveau bloc, ce qui signifie qu'ils doivent être placés avant l'élément de code que vous documentez. Les outils courants d'extraction des commentaires XML du code .NET ne savent pas comment analyser les commentaires en ligne de ce type. Si vous avez besoin de cette capacité, vous devrez écrire votre propre analyseur.

Answer 2

Il n'y a pas de moyen intégré de le faire. Le système de documentation XML est hiérarchique ; il définit une relation entre la balise <summary /> et les données qui le suivent immédiatement.

Answer 3

Oui, il suffit de le mettre AVANT la chose que vous voulez commenter.

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