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

C Discussion :

Créer une documentation de son code C


Sujet :

C

  1. #1
    Rédacteur
    Avatar de Yoshio
    Homme Profil pro
    Inscrit en
    Septembre 2005
    Messages
    1 732
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : Belgique

    Informations forums :
    Inscription : Septembre 2005
    Messages : 1 732
    Points : 2 981
    Points
    2 981
    Par défaut Créer une documentation de son code C
    Bonjour,

    J'aimerais savoir s'il existe le même style de "programme" qu'en PHP qui permet de commenter son code assez proprement.
    ex en php => http://www.phpdoc.org/

  2. #2
    Rédacteur
    Avatar de Franck.H
    Homme Profil pro
    Développeur .NET
    Inscrit en
    Janvier 2004
    Messages
    6 951
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 46
    Localisation : France, Haut Rhin (Alsace)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : Service public

    Informations forums :
    Inscription : Janvier 2004
    Messages : 6 951
    Points : 12 462
    Points
    12 462
    Par défaut
    Doxygen, c'est dans le même style que Javadoc, ca fonctionne super !
    Mon Site
    Ma bibliothèque de gestion des chaînes de caractères en C

    L'imagination est plus importante que le savoir. A. Einstein

    Je ne répond à aucune question technique par MP, merci d'avance !

  3. #3
    Rédacteur
    Avatar de Yoshio
    Homme Profil pro
    Inscrit en
    Septembre 2005
    Messages
    1 732
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : Belgique

    Informations forums :
    Inscription : Septembre 2005
    Messages : 1 732
    Points : 2 981
    Points
    2 981
    Par défaut
    Yep merci bien c'est ce que je cherchais.

    Mais il n'y a pas moyen d'avoir un du style PHP genre :
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
     
    /**
     * Add x to y
     * @param int x
     * @param int y
     * @return int x + y
     */
    J'ai vaguement regardé mais je ne pense pas que ca soit pareille (previent moi si ce n'est pas le cas).

    Existe t-il un comparateur de ce genre d'outil sur developpez.com ? (je pense pas pour le C en tout cas).

  4. #4
    Rédacteur
    Avatar de Franck.H
    Homme Profil pro
    Développeur .NET
    Inscrit en
    Janvier 2004
    Messages
    6 951
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 46
    Localisation : France, Haut Rhin (Alsace)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : Service public

    Informations forums :
    Inscription : Janvier 2004
    Messages : 6 951
    Points : 12 462
    Points
    12 462
    Par défaut
    Version Doxygen:

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    /**
     * /param int x
     * /param int y
     * /return int x + y
     *
     * /brief Add x to y
     */
    /brief c'est pour une courte description, regarde dans la doc du programme sur le site officiel, y'a tout !
    Mon Site
    Ma bibliothèque de gestion des chaînes de caractères en C

    L'imagination est plus importante que le savoir. A. Einstein

    Je ne répond à aucune question technique par MP, merci d'avance !

  5. #5
    Rédacteur
    Avatar de Yoshio
    Homme Profil pro
    Inscrit en
    Septembre 2005
    Messages
    1 732
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : Belgique

    Informations forums :
    Inscription : Septembre 2005
    Messages : 1 732
    Points : 2 981
    Points
    2 981
    Par défaut
    c'est pas beau !!!

  6. #6
    Membre expérimenté
    Avatar de Gruik
    Profil pro
    Développeur Web
    Inscrit en
    Juillet 2003
    Messages
    1 566
    Détails du profil
    Informations personnelles :
    Âge : 40
    Localisation : France

    Informations professionnelles :
    Activité : Développeur Web

    Informations forums :
    Inscription : Juillet 2003
    Messages : 1 566
    Points : 1 727
    Points
    1 727
    Par défaut
    Si, Doxygen est pareil. Pour les commandes speciales, on a le choix entre l'ecriture Doxygen et l'ecriture Javadoc (\command ou @command)

    Donc oui, on peut commenter comme ceci
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    8
    /**
     * Blabla lbalblalbl blabla.
     * Blabl albalb la lbl lalblalblalblablalbla
     *
     * @param abc  Blablablablabl
     * @param def   Blab aueb yiuy. baiyiubya ibeubeaebhkjh 
     * @return        Blabab lablalblalbalblalbalb
     */
    Il ya tout plein de trucs pour "compatibilité avec javadoc", donc si tu connais javadoc, tu connais Doxygen

  7. #7
    Rédacteur
    Avatar de Yoshio
    Homme Profil pro
    Inscrit en
    Septembre 2005
    Messages
    1 732
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : Belgique

    Informations forums :
    Inscription : Septembre 2005
    Messages : 1 732
    Points : 2 981
    Points
    2 981
    Par défaut
    ah oki merci! Ca me va alors

+ Répondre à la discussion
Cette discussion est résolue.

Discussions similaires

  1. Créer une aide de son application
    Par g_barthe dans le forum Général Python
    Réponses: 3
    Dernier message: 20/05/2008, 18h53
  2. créer une installation de son application
    Par harald-aldb dans le forum GTK+ avec C & C++
    Réponses: 4
    Dernier message: 23/11/2007, 12h59
  3. Comment créer une image de son système ?
    Par cimbomlu dans le forum Ordinateurs
    Réponses: 5
    Dernier message: 18/10/2006, 08h27
  4. Un plugin efficace pour documenter facilemen son code?
    Par petozak dans le forum Eclipse Java
    Réponses: 2
    Dernier message: 08/09/2006, 11h05
  5. [VB6]:Créer une application de son projet
    Par gaetan.tranvouez dans le forum VB 6 et antérieur
    Réponses: 8
    Dernier message: 21/07/2006, 08h26

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