Fichier d'aide sous .net

Bonjour ,

Je suis stagiare et j'utilise depuis peu l'environnement dotnet avec lequel j'ai developpé une application asp.net en web forms.

Mon tuteur m'a demandé de faire un exécutable de mon application pour l'installer sur d'autres postes. Il souhaite aussi que cet executable incult un fichier d'aide (installation + utilisation).

Est il possible d'inserer sous dotnet un fichier d'aide dans mon projet ou dans l'exécutable ? si oui, comment

N'hesitez pas à me repondre, je vous remercie

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

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

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.