Un logiciel pour générer automatiquement des blocs de commentaires doxygen?

Je suis l'élaboration d'un vaste programme en C++ et j'ai maintenant décidé de document avec Doxygen.
Il y a beaucoup de classes, les méthodes, les fonctions, macros, et ainsi de suite. Donc je suis à la recherche d'un logiciel qui permettrait de scanner mon arbre source et insérez Doxygen blocs de commentaires sur le dessus de chaque "documentable élément" permettez-moi de les modifier plus tard et d'ajouter des détails tels que la méthode des descriptions et ainsi de suite.

N'a aucun de ces logiciels existent?

Je suis sous GNU/Linux avec le Code::Blocks IDE, donc pas de Visual Studio plugins sont nécessaires.

source d'informationauteur Simone Margaritelli

  1. 1

    Vous pouvez définir Doxygen pour extraire les non-documenté des éléments - qui peut faire ce que vous voulez sans ajout de blocs de commentaire le code encore.

    Après cela, vous pouvez créer des modèles /macros (dépend de votre IDE) pour créer des pré-formaté blocs pour chaque type d'élément, comme vous le voyez dans le code de documenter les éléments un par un.

    [modifier]
    Si vous utilisez Visual Studio, une introspection est disponible sur les classes et d'autres constructions dans le fichier, qui peut aider. Vous pouvez également prendre un coup d'oeil à Doxycomment - il peut-être certains de ce que vous voulez.

  2. 6

    Je suis assez perplexe ici.

    Quel est le but de générer automatiquement des commentaires ?

    Commentaires sont destinés à apporter une valeur supplémentaire:

    /**
 * \brief: finds the person based on its name
 * \param: name, the name of the person
 * \result: the person
 */
Person findPerson(Name name);

    N'est rien, mais l'encombrement de code qui encombrent mon précieux écran de l'immobilier. Et c'est autant que peut être généré automatiquement malheureusement... Notez en particulier que je n'ai aucune idée de ce qui se passe si jamais la fonction ne trouve pas la personne, ce qui semble vraisemblable: faut-il abandonner ? jette ? (qu'est-ce... ?) renvoie une valeur par défaut objet construit ?

    D'autre part:

    ///
///Try an exact match approach to begin with
///Uses the double metaphone algorithm
///  if none was found as we have
///  a western european clientele
///
Person findPerson(Name name)
{
}

    est beaucoup plus intéressant!

    • Maintenant je sais ce qu'est cette étrange collection de if qui semble exercer une sorte de reconnaissance sonore...
    • Je sais son nom afin que je puisse chercher sur Internet pour vérifier sa mise en œuvre (fonctionnalité)
    • Et je sais pourquoi il a été sélectionné et donc quand je doit réévaluer son utilisation (pour un occidental clientèle européenne, de sorte que si nous développer sur l'arabe marché aurez besoin d'adaptation...)

    Malheureusement, cela ne va pas être généré automatiquement.

  3. 2

    Ok, c'est un vieux post, mais j'ai juste eu le même problème et j'ai trouvé doxymacs. Il s'intègre bien avec emacs et génère doxymacs commentaires de vos fonctions et de vos fichiers. Après la mise de la .el fichier dans votre emacs chemin, vous pouvez ajouter un crochet pour le rendre disponible à chaque fois que vous ouvrez un C/C++ fichier "(add-hook 'c-mode-commune-crochet'doxymacs-mode)" et à commenter les fonctions C-c d f et les fichiers de C-c d i, il existe d'autres types de commentaires disponible, il suffit de consulter la page du projet: http://doxymacs.sourceforge.net/

  4. 1

    La publication pour genDoxygenC.py a de nombreux index/espaces erreurs. Depuis le Python de flux de programme dépend d'une bonne indexation, je crains que le bloc interne de la addDoxygenComment méthode pourrait ne pas être correcte. Est-il une chance, vous pouvez poster le fichier source vers ici?

  5. 0

    Il y a également un accès gratuit à Doxygen générateur de C++ qui utilise la macro explorer plugin pour Visual Studio 2015, qui peut être trouvé ici:
    https://github.com/cppocl/visual_studio_macros