[VS2005] Comment utiliser la documentation du code en C++ ?

Version imprimable

17/07/2006, 20h05
StormimOn

[VS2005] Comment utiliser la documentation du code en C++ ?

Bonjour,

j'essaye d'intégrer la documentation du code XML dans un projet C++/CLI, car j'ai lu que l'on pouvait utiliser la documentation comme en C# avec les ///<summary></summary> par exemple. Mais je n'ai pas l'aide associée qui s'affiche lorsque je saisie le code, l'aide sur la méthode, les paramètres, ... tout ca ne s'affiche pas lors de la saisie.

Y'a t-il quelque chose de précis à faire ?
18/07/2006, 08h20
nico-pyright(c)

tiens, l'article dont je t'avais parlé sur msdn http://msdn2.microsoft.com/en-us/library/ms177226.aspx

Je l'ai lu, mais ca ne fonctionne pas. Par exemple dans mon .h j'ai documenté une méthode
Code:

1 2 3 4 5 6 7 8 /// <summary> /// Cette fonction permet de récupérer un certificat ... /// </summary> /// <param name="certificate">Certificat X509v3 ...</param> /// <param name="keyUsage">Masque correspondant aux ...</param> /// <param name="showOneCert">Lorsque ce flag est positionné à 1 ...</param> /// <returns>Adresse d’un pointeur ...</returns> IntPtr SelectCertificate(String ^ certificate, int keyUsage, int showOneCert);
Cette méthode se trouve dans un wrapper C++/CLI. Je l'utilise depuis un projet C# et à ce niveau je n'ai aucune documentation lors de la saisie du code. J'ai aussi essayé de générer la doc Xml du projet C++/CLI mais je n'ai rien en sortie, donc je ne comprends pas.

Par contre au moment de la saisie du code en C++/CLI, j'ai ca : http://img99.imageshack.us/img99/8282/imgcr9.jpg
Mais ca n'apparait qu'à ce moment, càd quand la liste des membres de l'objet s'affiche.

Bref, je n'arrive pas à documenter mon code correctement pour le moment.

18/07/2006, 14h45
neguib

Je vais peut être dire une bêtise (mais notre maître VC++ est là pour surveiller mes dires ;) ); ne serait-ce pas une des options du compilateur Visual C++ > /doc
18/07/2006, 15h01
nico-pyright(c)

euh ... qui ca ? :P

j'avoue ne m'etre jamais penché sur la doc xml, donc là, je vais etre très très vite limité
18/07/2006, 17h33
StormimOn

Citation:

Envoyé par neguib

Je vais peut être dire une bêtise (mais notre maître VC++ est là pour surveiller mes dires ;) ); ne serait-ce pas une des options du compilateur Visual C++ > /doc

J'ai justement activé cette option. J'ai bien le fichier Xml actuellement, par contre je n'arrive pas à avoir l'intellisense dans mon projet C#. Il faut placer le Xml avec l'assembly si j'ai bien suivi ce qui est marqué sur MSDN, mais rien n'y fait.

Bon, je vois enfin la documentation de code de mon projet C++/CLI dans l'intellisense de mon projet C#.
J'ai supprimé le fichier .ncb, qui se trouve dans le répertoire de la solution avant de lancer Visual Studio pour qu'il le recrée. A priori ca a résolu le problème.
19/07/2006, 13h03
neguib

:merci: pour l'astuce ;)
19/07/2006, 14h13
nico-pyright(c)

je t'attends pour rédiger quelque chose pour la faq :mrgreen: :aie:
16/09/2006, 16h46
blastou

Désoler, de réuppé un vieux sujet, mais j'ai éxactement le même soucis, sauf que je n'ai rien compris à la solution donnée par StormimOn.

Donc j'ai le /Doc d'activé dans mon projet (uniquement C++ pas d'autre langage a coté) et le Xml ce génère normalement. Cependant l'Intellissence ne me donne strictement aucune des balises, et ça me gène. J'ai bien essayé de supprimer le .ncb de l'intellissense mais ça ne change rien. Le seul truc que je ne comprends pas c'est : "Il faut placer le Xml avec l'assembly si j'ai bien suivi ce qui est marqué sur MSDN".

De quel XML tu parles là parceque MSDN parles d'un ".xml file can also be used to support IntelliSense on your component". Enfin, bref je ne sais pas comment faire et aimerais bien être éclairé sur le sujet.