Où placer les blocs de commentaires doxygen pour une bibliothèque interne - H ou dans les fichiers CPP?

Le sens commun dit que le Doxygen blocs de commentaires sont à mettre dans les fichiers d'en-tête où les classes, structures, énumérations, les fonctions, les déclarations. Je suis d'accord que c'est un bon argument pour les bibliothèques qui sont moyennes à être diffusé sans son source (uniquement les en-têtes et les bibliothèques avec le code objet).

MAIS...j'ai pensé exactement la démarche inverse, quand je suis à l'élaboration d'un interne à l'entreprise (ou comme un projet à part pour moi) la bibliothèque qui sera utilisé, avec son code source complet. Ce que je propose, c'est de mettre les gros blocs de commentaires dans les implémentations de fichiers (PHP, INL, RPC, etc.) afin de ne PAS encombrer l'interface des classes et des fonctions déclarées dans l'en-tête.

Pour:

  • Moins d'encombrement dans les fichiers d'en-tête, seulement la catégorisation des fonctions peuvent être ajoutées.
  • Les blocs de commentaires qui sont affichées lors de l'Intellisense, par exemple, est utilisé n'est pas en conflit - est-ce un défaut que j'ai constaté quand j'ai un bloc de commentaire pour une fonction dans les .H fichier et son inline définition dans le même .H fichier inclus à partir de .INL fichier.

Contre:

  • (Le plus évident) Les blocs de commentaires ne sont pas dans les fichiers d'en-tête lorsque les déclarations sont.

Donc, ce que vous en pensez et éventuellement proposer?

InformationsquelleAutor Singulus | 2008-12-10