IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Dotnet Discussion :

Générer documentation HTML


Sujet :

Dotnet

  1. #1
    Membre extrêmement actif

    Homme Profil pro
    Software Developer
    Inscrit en
    Mars 2008
    Messages
    1 470
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : Royaume-Uni

    Informations professionnelles :
    Activité : Software Developer

    Informations forums :
    Inscription : Mars 2008
    Messages : 1 470
    Par défaut Générer documentation HTML
    Bonjour,

    Je souhaiterais savoir comment vous générez la documentation de vos programmes.

    Je recherche un outil qui génère une aide HTML de type MSDN.
    Soit il n'y a pas, soit ça ne fonctionne pas.
    N'y a t'il qu'une génération des commentaires au format XML inexploitable ?

    Sous Java la javadoc est si simple à générer, Visual Studio serait-il si compliqué pour une tâche si importante ?

  2. #2
    Rédacteur/Modérateur


    Homme Profil pro
    Développeur .NET
    Inscrit en
    Février 2004
    Messages
    19 875
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 43
    Localisation : France, Paris (Île de France)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Février 2004
    Messages : 19 875
    Par défaut
    Il n'y a aucun outil fourni avec Visual Studio pour faire ça, ce que j'ai toujours trouvé aberrant...

    Tu peux utiliser Doxygen, qui est assez simple, mais le format n'est pas du tout celui de la MSDN, et le support des dernières évolutions de C#/.NET n'est pas forcément très bon (genre méthodes d'extensions, propriétés attachées en WPF, etc)

    Après, l'outil "officiel" proposé par Microsoft est Sandcastle, qui génère la doc au format MSDN (VS2005/2008, je suis pas sûr qu'il sache générer le format VS2010). C'est puissant, ça couvre à peu près tous les besoins... mais c'est une horreur à utiliser, vraiment très complexe. Heureusement il y a un outil qui fournit une GUI et facilite (un peu) la tâche : Sandcastle Help File Builder (nécessite d'avoir aussi installé Sandcastle). Tant que tu cherches pas à faire des choses compliquées, tu devrais pouvoir t'en sortir avec ça. Par contre c'est vite galère si tu veux sortir des sentiers battus (par exemple générer la doc en français, comme j'ai fait pour Dvp.NET)

  3. #3
    Membre extrêmement actif

    Homme Profil pro
    Software Developer
    Inscrit en
    Mars 2008
    Messages
    1 470
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : Royaume-Uni

    Informations professionnelles :
    Activité : Software Developer

    Informations forums :
    Inscription : Mars 2008
    Messages : 1 470
    Par défaut
    Merci tomlev.

    SandCastle répond enfin à mes attentes.

    Merci aussi pour le lien Dvp.NET au passage que je connaissais pas, mais peux tu me dire comment tu fais pour générer sans les URL absolue de frame et éviter le message d'alerte sécurité Javascript ? Chrome ne fonctionne pas sinon.

    Et j'ai une autre question, comment se fait t'il que quand je génère la doc de toute ma solution, certains projets sont ignorés ?

  4. #4
    Rédacteur/Modérateur


    Homme Profil pro
    Développeur .NET
    Inscrit en
    Février 2004
    Messages
    19 875
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 43
    Localisation : France, Paris (Île de France)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Février 2004
    Messages : 19 875
    Par défaut
    Citation Envoyé par alex_vino Voir le message
    peux tu me dire comment tu fais pour générer sans les URL absolue de frame et éviter le message d'alerte sécurité Javascript ? Chrome ne fonctionne pas sinon.
    Euh... aucune idée. J'ai rien fait de spécial pour ça il me semble, et j'ai jamais vu d'alerte de sécurité JS (je peux pas tester avec Chrome au bureau, dans ma boite on n'a pas le droit de l'installer )

    Citation Envoyé par alex_vino Voir le message
    Et j'ai une autre question, comment se fait t'il que quand je génère la doc de toute ma solution, certains projets sont ignorés ?
    Re-euh...
    Tu es sûr que la case "générer la doc XML" est bien cochée dans tous les projets ?
    Et dans Sandcastle, tu as bien ajouté toutes les DLL et tous les fichiers XML de doc ?

Discussions similaires

  1. Réponses: 2
    Dernier message: 13/02/2014, 17h09
  2. [OWL] Générer la documentation HTML d'une ontologie
    Par developper86 dans le forum Ontologies
    Réponses: 1
    Dernier message: 10/02/2012, 17h12
  3. [XSLT] Générer Document HTML via un XSL
    Par dahu17 dans le forum XSL/XSLT/XPATH
    Réponses: 9
    Dernier message: 12/09/2007, 16h51
  4. [DOM] Parser un document Html distant
    Par le Daoud dans le forum Format d'échange (XML, JSON...)
    Réponses: 3
    Dernier message: 02/05/2005, 14h19
  5. [XSLT] Générer un HTML avec du FO
    Par virgul dans le forum XSL/XSLT/XPATH
    Réponses: 3
    Dernier message: 27/04/2005, 10h19

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo