Discussion :

[djihan]

Bonjour,

Je viens de développer un projet assez conséquent et comme un idiot j'ai oublié de commenter l'ensemble du code...

Connaîtriez-vous un logiciel pour ajouter automatiquement l'ensemble des balises doxygen à un code déjà existant afin qu'il ne me reste plus qu'à ajouter le détail des fonctions svp ?

Je vous remercie

[Pyramidev]

Je n'en connais pas, mais je doute de l'utilité d'un tel outil.

Les fonctions n'ont pas toutes besoin de commentaires.
Par exemple, dans le code suivant, aucun de mes commentaires n'est utile :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
class Point
{
public:
	/*!
         * \brief Construire un point du plan à partir de ses coordonnées cartésiennes.
         * \param x abscisse
         * \param y ordonnée
         */
	constexpr Point(double x, double y) noexcept : m_x(x), m_y(y) {}
 
	//! Retourner une copie de l'abscisse du point.
	constexpr double getX() const noexcept { return m_x; }
 
	//! Retourner une copie de l'ordonnée du point.
	constexpr double getY() const noexcept { return m_y; }
 
private:
	double m_x; //!< abscisse
	double m_y; //!< ordonnée
};

En outre, il existe des balises qui sont parfois pertinentes sans qu'un outil d'analyse de code ne puisse savoir où elles seraient pertinentes.
Exemples en vrac : \warning, \deprecated, \remark, \todo.

Il vaut mieux réfléchir au cas par cas.

De mon point de vue, tout commentaire dans le code doit avoir une valeur ajoutée. Il doit donner plus d'informations que celles qui sont déjà apportées par le nom de la fonction, le nom et le type des paramètres, etc.

Quelques exemples de commentaires pertinents :

• Décrire le rôle d'une classe, en particulier comment elle interagit avec les autres classes de même niveau et celles de niveau inférieur.
• Décrire en quelques mots ce que fait une fonction si les idées de cette suite de mots ne peuvent être concentrées dans un nom de fonction.
• Expliquer un choix qui peut paraître étrange pour le lecteur (ex : bidouille pour contourner un bogue du compilateur ou d'une bibliothèque).
• Quand une classe commune à plusieurs projets a beaucoup d'instances dans un programme limité en mémoire, écrire qu'il ne faut pas augmenter la quantité de mémoire utilisée par la classe.

[djihan]

Merci de ta réponse, je comprends ce que tu veux dire, mais là c'est surtout dans l'optique de générer un document en sortie, donc tes commentaires mis en exemple sont utiles doxygen avec l'aide de graphiz peut faire les graphs de liaison etc...
C'est pour avoir un document listant l'ensemble des classes, méthodes etc... sans pour autant avoir l'intégralité du code sous les yeux

Cela me surprend vraiment de ne pas trouver un outil générant automatiquement les commentaires doxygen pour les .h vu la grande utilisation de cet outil (doxygen).

[Pyramidev]

C'est pour avoir un document listant l'ensemble des classes, méthodes etc... sans pour autant avoir l'intégralité du code sous les yeux

Dans ce cas, dans ton Doxyfile, il suffit de :

• mettre éventuellement à YES des options dont le nom commence par EXTRACT_, par exemple EXTRACT_PRIVATE pour voir la documentation Doxygen des membres privés et de
• laisser à NO des options dont le nom commence par HIDE_, par exemple HIDE_UNDOC_MEMBERS et HIDE_UNDOC_CLASSES qui cachent les membres et les classes sans documentation Doxygen.

[djihan]

OK merci je vais voir pour ajouter cette option dan smon doxyfile et voir si même vide la génération est effectuée