Dois-je utiliser les commentaires Doxygen pour les membres privés et les fonctions gratuites? Je viens du monde Java, et je n'ai jamais ajouté Javadoc pour les membres privés. Est-ce une pratique acceptable dans le monde C++?Commentaires Doxygen pour les membres privés et les fonctions gratuites?
2
A
Répondre
0
Je dirais que c'est à peu près une question indépendante de la langue. Vous documentez les membres que vous voulez documenter.
1
Dépend de l'audience cible de la documentation. Si c'est pour une publication publique, alors non, ils n'ont pas besoin de connaître les variables internes et privées.
Si c'est pour un usage interne, alors oui, ils ont sûrement besoin de connaître l'utilisation des variables privées et des fonctions libres.
0
Vous pouvez documenter des fonctions privées - nous faisons et utilisons @internal
pour fournir de la documentation publique et développeur.
Nous utilisons également une pratique d'implémentation privée dans laquelle les implémentations sont cachées à l'utilisateur.