61 votes

Documentation XML pour un espace de noms

Rédigeriez-vous une xml-doc pour un espace de noms ? Et si oui, comment et où ?

Je penserais, si c'est possible, à un fichier presque vide comme celui-ci :

/// <summary>
/// This namespace contains stuff
/// </summary>
namespace Some.Namespace
{

}

Mais cela fonctionnera-t-il ? Puisque vous... "déclarez", ou au moins utilisez l'espace de noms dans tous les autres fichiers également... et que se passerait-il si vous écriviez un truc de documentation xml ailleurs sur le même espace de noms ? L'un des deux serait-il supprimé ? Ou seraient-ils fusionnés d'une manière ou d'une autre ?

0voto

Kirtan Points 11022

Il n'est pas possible de mettre des commentaires sur les espaces nominatifs.

UseNamespaceDocSummaries sur http://ndoc.sourceforge.net/content/documenters.htm

0voto

jonp Points 10039

Si l'on utilise Mono 's mdoc vous pouvez documenter les membres de l'espace de noms en éditant les fichiers de documentation ns-*.xml.

Voir le Documentation sur le format de fichier mdoc pour plus de détails.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X