OVH Cloud OVH Cloud

commenter son code

3 réponses
Avatar
Laurent
Salut,

Je développe des classes qui seront utilisées par mes collègues, j'aimerais
leur faciliter la vie (et la mienne aussi) en documentant un maximum mon code.
J'ai trouvé de la doc sur les commentaires XML, mais je voudrais aller plus
loin en faisant comme 'crosoft. Je m'explique : avec l'intellisense, les
tooltips décrivant les surcharges de méthodes décrivent aussi chaque
paramètres, le retour ...

les tags XML existant ne sont pas visibles avec l'intellisense...
Est-ce possible, et si oui COMMENT ???!?

Merci d'avance pour vos réponses
Bon dév!

--
Laurent M.
Développeur .NET

3 réponses

Avatar
Fabien Bezagu
Laurent,

MS ne va pas plus loin que la doc XML me semble-t-il. En utilisant les bons
marqueurs, tu devrais pouvoir tout documenter.
Plus de détails ici :

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/vclrfTagsForDocumentationComments.asp

Fabien

"Laurent" a écrit dans le message de
news:
Salut,

Je développe des classes qui seront utilisées par mes collègues,
j'aimerais
leur faciliter la vie (et la mienne aussi) en documentant un maximum mon
code.
J'ai trouvé de la doc sur les commentaires XML, mais je voudrais aller
plus
loin en faisant comme 'crosoft. Je m'explique : avec l'intellisense, les
tooltips décrivant les surcharges de méthodes décrivent aussi chaque
paramètres, le retour ...

les tags XML existant ne sont pas visibles avec l'intellisense...
Est-ce possible, et si oui COMMENT ???!?

Merci d'avance pour vos réponses
Bon dév!

--
Laurent M.
Développeur .NET


Avatar
charles.feval
Tout à fait, les commentaires XML, lorsqu'ils contiennent les bonnes
balises, sont utilisés par Intellisense...
Avatar
Serge
Bonjour,
tu peux generer des fichiers d'aide a partir des commentaires en utilisant
le logiciel "nDoc"
--
Serge


"Laurent" wrote:

Salut,

Je développe des classes qui seront utilisées par mes collègues, j'aimerais
leur faciliter la vie (et la mienne aussi) en documentant un maximum mon code.
J'ai trouvé de la doc sur les commentaires XML, mais je voudrais aller plus
loin en faisant comme 'crosoft. Je m'explique : avec l'intellisense, les
tooltips décrivant les surcharges de méthodes décrivent aussi chaque
paramètres, le retour ...

les tags XML existant ne sont pas visibles avec l'intellisense...
Est-ce possible, et si oui COMMENT ???!?

Merci d'avance pour vos réponses
Bon dév!

--
Laurent M.
Développeur .NET