Fichier d'aide sous .net
SW_87
Messages postés
56
Date d'inscription
mercredi 16 mars 2005
Statut
Membre
Dernière intervention
4 août 2005
-
4 août 2005 à 10:46
Lutinore Messages postés 3246 Date d'inscription lundi 25 avril 2005 Statut Membre Dernière intervention 27 octobre 2012 - 4 août 2005 à 16:27
Lutinore Messages postés 3246 Date d'inscription lundi 25 avril 2005 Statut Membre Dernière intervention 27 octobre 2012 - 4 août 2005 à 16:27
3 réponses
Lutinore
Messages postés
3246
Date d'inscription
lundi 25 avril 2005
Statut
Membre
Dernière intervention
27 octobre 2012
41
4 août 2005 à 15:41
4 août 2005 à 15:41
Salut, pour créer un fichier d'aide il te suffit d'utiliser les balises de documentation et de cocher dans les propriétés du projet "XML documentation file". ( option -doc en ligne de commande ).
/// <summary>
/// Cette fonction fait un truc : )
/// </summary>
public void DoSomething( )
{
}
Ca va créer un fichier "brute" en XML, que tu peux transformer, pour une documentation professionnelle utulises l'outil NDoc. Et il n'est pas conseillé d'inclure un fichier d'aide dans un exécutable, vu sa taille en général,
>> aspfr.com
/// <summary>
/// Cette fonction fait un truc : )
/// </summary>
public void DoSomething( )
{
}
Ca va créer un fichier "brute" en XML, que tu peux transformer, pour une documentation professionnelle utulises l'outil NDoc. Et il n'est pas conseillé d'inclure un fichier d'aide dans un exécutable, vu sa taille en général,
>> aspfr.com
SW_87
Messages postés
56
Date d'inscription
mercredi 16 mars 2005
Statut
Membre
Dernière intervention
4 août 2005
4 août 2005 à 16:06
4 août 2005 à 16:06
Oki ! je te remercie mais ça permet
d'expliquer seulement les classes et les fonctions. Si je souhaite
faire un manuel d'installation comment je fais
d'expliquer seulement les classes et les fonctions. Si je souhaite
faire un manuel d'installation comment je fais
Lutinore
Messages postés
3246
Date d'inscription
lundi 25 avril 2005
Statut
Membre
Dernière intervention
27 octobre 2012
41
4 août 2005 à 16:27
4 août 2005 à 16:27
La réponse est simple, les balises disponibles ( il n'y a pas que <summary></summary> ) permettent de créer exactement la même documentation que celle de Microsoft une fois passer dans NDoc, ( ou une autre transformation ) autant dire que c'est plutot complet. Sinon tu fais un "banal" fichier *.doc, *.pdf *.rtf mais la tu perds le bénéfice de synchronization de ta doc avec les commentaires de ton code.
