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

MFC Discussion :

Comment commenter son code source proprement ...


Sujet :

MFC

  1. #1
    Membre actif

    Profil pro
    Développeur informatique
    Inscrit en
    décembre 2003
    Messages
    286
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations professionnelles :
    Activité : Développeur informatique

    Informations forums :
    Inscription : décembre 2003
    Messages : 286
    Points : 251
    Points
    251
    Par défaut Comment commenter son code source proprement ...
    Bonjour

    J'ai un projet que j'aimerais bien commenter de facon un peu plus "claire".
    J'ai bien des commentaires mais bon ...

    Mes questions sont donc :
    - Comment bien commenter son code facilement sans que ca soit illisible ?
    - Existe t'il des manières de commenter / des outils (internes ?) pour Visual C++ 6 ? (et non .net) (un peu comme la java doc par exemple ...)

    merci !


    La FAQ et la recherche ne m'ont pas aidé ...
    .: La cosse : il n'y a que ça de vrai :.

  2. #2
    Expert éminent sénior

    Homme Profil pro
    pdg
    Inscrit en
    juin 2003
    Messages
    5 732
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 39
    Localisation : France, Hérault (Languedoc Roussillon)

    Informations professionnelles :
    Activité : pdg

    Informations forums :
    Inscription : juin 2003
    Messages : 5 732
    Points : 10 546
    Points
    10 546
    Billets dans le blog
    3
    Par défaut
    Avec VC++ 2005 y'a les commentaires xml, à la C#. Mais on utilise plus traditionnellement doxygen.
    Les commentaires doivent apporter quelque chose. Si c'est pour réécrire en français le code C++, ça sert à rien. Par contre si tu expliques ton algo et le rôle des variables, c'est utile. Perso, j'essaye de décrire mon algo, pour que si on supprime le code on puisse retrouver son fonctionnement via les commentaires. Mais j'aime bien aussi l'approche de la programmation XP qui dit aucun commentaire car s'il en faut c'est que le code est dur à comprendre, donc il faut le retravailler pour le simplifier. C'est exagéré, mais tu vois l'idée : commenter ce que fait le code, et non comment il le fait.
    Ecrire les commentaires avant le code, c'est utile aussi pour se rendre compte de bêtises avant de les écrire.

  3. #3
    Membre régulier
    Avatar de barthelv
    Inscrit en
    mars 2003
    Messages
    267
    Détails du profil
    Informations forums :
    Inscription : mars 2003
    Messages : 267
    Points : 123
    Points
    123
    Par défaut
    Comme outil il existe Doxygen qui est gratuit, tres simple et fait des docs super. Il te cree meme les schemas qui te montrent comment s'incluent tes fichiers et classes. Tres utile pour voir si l'on a fait du code propre. Il est tres utilise dans le monde professionnel.

    http://www.stack.nl/~dimitri/doxygen/

    Pleins d'exemples de docs avec Doxygen:

    http://www.stack.nl/~dimitri/doxygen/projects.html

  4. #4
    Membre actif

    Profil pro
    Développeur informatique
    Inscrit en
    décembre 2003
    Messages
    286
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations professionnelles :
    Activité : Développeur informatique

    Informations forums :
    Inscription : décembre 2003
    Messages : 286
    Points : 251
    Points
    251
    Par défaut
    doxygen .. je vais me renseigner ..

    Sinon j'ai bien précisé VC++ 6, pas 2005 ...

    En fait je programme depuis quelques années donc je sais commenter "en gros".

    Mais la je chercherais à avoir quelque chose de plus propre, p-e même que VC++ 6 utilise des instructions pour les commentaires afin de pouvoir les traiter ... bref cela je ne le sais pas , d'où ma question

    merci ...

    EDIT : merci aussi barthelv Je vais donc voir d'un peu plus près ce logiciel ...
    Si vous avez d'autres renseignements à m'apporter, n'hesitez pas
    .: La cosse : il n'y a que ça de vrai :.

Discussions similaires

  1. Faut-il commenter son code source pour le rendre plus lisible et maintenable ?
    Par mayayu dans le forum Débats sur le développement - Le Best Of
    Réponses: 149
    Dernier message: 09/11/2009, 03h30
  2. Réponses: 15
    Dernier message: 16/01/2009, 01h16
  3. Comment présenter un code source ?
    Par khayyam90 dans le forum Mise en forme
    Réponses: 2
    Dernier message: 11/11/2005, 08h27
  4. [Perf] Comment optimiser son code ?
    Par Frifron dans le forum Général Java
    Réponses: 12
    Dernier message: 11/08/2005, 10h05
  5. [Juridique] Comment réutiliser le code source d'une classe ?
    Par mathieu dans le forum Général Java
    Réponses: 8
    Dernier message: 17/05/2004, 14h40

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