Discussion :

[angello]

bonjour,

je cherche des info sur la generation de doc auto exclusivement avec VISUAL.
Malheureusement aucun autre logiciel (Doxygen ou autre ) n'est toléré.

je n'arrive pas à avoir comme les librairie l'aide dans le "object browser", c'est a dire une description des methode et autre pour une utilisation par un tier.


en exemple une partie de mon code:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
 
 
		/*==============================constructor====================================*/
		///<summary>default constructor</summary>
		///<param>none</param>
		///<returns>objet INSTRUMENT</returns>
		///<example>INSTRUMENT* a = new INSTRUMENT;</example>
		INSTRUMENT(void);
		///<summary>constructor with 1 parameter</summary>
		///<param>string name Instrument</param>
		///<returns>objet INSTRUMENT</returns>
		///<example>INSTRUMENT* a = new INSTRUMENT("my_instrument");</example>
		INSTRUMENT(std::string stringINSTRUMENTNameGiveByUser);

je vous joint la ligne de command de generation du XML:

"XXXXX" /Fo"C:\tmp\PROJECT\XXXX.xml"

j'obtient ceci dans un fichier xml temporaire

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
 
<?xml version="1.0"?>
<doc>
<members>
</members>
</doc>

et dans le fichier xml du projet:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
 
        <member name="M:INSTRUMENT.#ctor(std.basic_string&lt;System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte,std.char_traits{System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte},std.allocator&lt;System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte&gt;&gt;)">
            <summary>constructor with 1 parameter</summary>
            <param>string name Instrument</param>
            <returns>objet INSTRUMENT</returns>
            <example>INSTRUMENT* a = new INSTRUMENT("my_instrument");</example>
        </member>
        <member name="M:INSTRUMENT.#ctor">
            <summary>default constructor</summary>
            <param>none</param>
            <returns>objet INSTRUMENT</returns>
            <example>INSTRUMENT* a = new INSTRUMENT;</example>
        </member>

et dans le "browser object" de visual j ai:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

public : INSTRUMENT::INSTRUMENT(std::string stringINSTRUMENTNameGiveByUser)

et pas plus.

merci si un expert visual a la reponse.

PS: j ai deja visité la msdn et le forum

[Médinoc]

La fameuse "aide autogénérée" j'ai du mal à voir dans quoi elle marche exactement.
À mon boulot, pendant une époque on a utiliser NDoc2 pour générer une aide "web" à partir de ces XML.

PS: Tu n'utilises pas <param> correctement. Normalement, il faut un truc du genre <param name="truc">machin bidule</param>

[angello]

merci pour la precision de mon erreur, j'essai desuite.

je doit refourguer le BB à d'autre et la doc est super importante je ne doit pas avoir à recourrir à un logiciel tier.

[angello]

je viens de corriger toutes les erreurssur les balises <param>.

mais je n'ai toujours pas la description dynamique dans le browser de visual.

si la communauté à une idée?

[bacelar]

Why Doc Auto ???

http://shfb.codeplex.com/

[angello]

faire qqc de propre.
diagramme de classe, doc du soft, diagramme de sequence.

c'est pour un vrai projet.
Recette cliente derriere.

[bacelar]

SandCastel, c'est propre.