Je n'ai jamais écrit de documentation pour un code de style C avant (seulement fait asdoc et phpdoc). J'ai regardé Doxygen pour documenter mon code Objective-C, mais je ne sais pas où placer les commentaires. Dois-je documenter les fichiers .h ou dois-je ajouter les commentaires aux fichiers .m? ou les deux? D'autres recommandations?Où documenter le code avec Doxygen
Par convention, les commentaires doivent être placés dans des fichiers d'en-tête (* .h), parce qu'ils contiennent la plupart des déclarations et ils sont plus faciles à lire.
La documentation dans les fichiers source (* .m) est utile lorsqu'il n'y a aucun fichier d'en-tête associé: par exemple, lorsque vous utilisez une catégorie privée pour une classe.
De plus, Doxygen a quelques options qui imprimeront des avertissements si certains documents ne sont pas ou pas assez documentés.
Edit:
Voici un lien vers un tutoriel appelé Documenting Objective-C with Doxygen.
Regardez la documentation de doxygen de certains projets pour voir ce qu'ils font.
http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/ est un qui m'a impressionné, mais je suis sûr que vous pouvez trouver un projet objectif-c qui fait du bon travail.
La documentation de l'API se trouve dans le fichier .h. Vous pourriez avoir quelques détails d'implémentation qui valent la peine d'être documentés, de sorte que vous en aurez aussi dans le fichier .m. Ne te répète pas. Évitez de répéter ce que votre code dit déjà.
Vos commentaires appartiennent généralement aux fichiers .h, car c'est ce que les gens regardent pour savoir comment utiliser vos classes.
Here est un exemple plus en profondeur de la façon d'utiliser Doxygen spécifiquement avec Objective C