Et pourtant... Une bonne doc générée à partir des headers (via Doxygen par exemple) est largement, très largement supérieure à la lecture de l'entête "directement".
On peut y voir la doc des fonctions, bien sûr, ainsi que les relations de dépendances, et y ajouter des exemples d'utilisation piochés directement dans ton code (ex : programme de test et/ou fichier d'implémentation), le tout étant plus facile à maintenir qu'un manuel utilisateur "papier" séparé.
Dans un format adéquat (CHM sous Windows, QHP pour QT, manpages sous *nix, etc.), tu peux même directement inclure l'aide de tes modules dans celle de ton IDE favori, ce qui rend totalement inutile la "lecture" des fichiers d'entête eux-même... Bref, ce que tu fais déjà avec les entêtes standards, car je pense que comme beaucoup, sauf cas exceptionnel bien entendu, tu n'ouvres jamais les entêtes usuels (stdio.h, vector, etc.) pour voir comment c'est fait, n'est-ce pas ?
Partager