Générateur de documentation pour Objective-C?
Existe-t-il un générateur de documentation généralement accepté pour Objective-C (similaire au RDoc pour Ruby)? J'ai vu Doxygen et ObjcDoc, et je me demande ce qui est le plus utilisé.
Doxygen est probablement l’option la plus largement utilisée. Parce que ce n'est pas juste pour ObjC (doxygen supporte beaucoup d'autres langues), le développement est vivant et la communauté assez forte. HeaderDoc (maintenant un projet open source), en comparaison, semble avoir largement stagné. HeaderDoc produit uniquement une sortie HTML, tandis que doxygen produit également des formulaires PDF, LaTeX et de nombreux autres formulaires de sortie en plus du HTML. Même Apple semble recommander doxygen, avec this guide pour produire automatiquement des ensembles de documentation, compatibles avec le visualiseur d’aide de Xcode, à partir de votre processus de construction de Xcode.
Il convient de noter que doxygen peut lire les commentaires de style HeaderDoc. Vous pouvez donc écrire votre documentation dans le style HeaderDoc et décider ultérieurement de produire la sortie finale à l'aide de doxygen ou de HeaderDoc.
Découvrez appledoc . C'est basé sur Doxygen . Vous pouvez voir qu'il mange sa propre nourriture pour chien en ce sens qu'il génère la documentation de référence appledoc pour le le code source appledoc . Comparez, par exemple, GBComment.h à GBComment Référence de classe .
Consultez également Le Guide de la documentation de Xcode pour des instructions détaillées sur la création d'une documentation compatible avec Xcode. Ce sont les instructions qui automatisent appledoc.
Doxygen est très largement utilisé. Il me semble que je l’utilise aussi comme réponse SO environ une fois par semaine.
Un nouvel outil est Jazzy by Realm, qui génère une documentation dans le nouveau style Xcode 6 et prend en charge la génération de documentation Swift (ainsi que Objective-C).
En plus du doxygen, Apple dispose d’un outil qui accompagne les outils de développement. Il génère le type de documentation que vous voyez sur des choses comme le framework SystenConfiguration. L'outil s'appelle HeaderDoc. La documentation se trouve dans HeaderDoc User Guide .
Peut-être devriez-vous essayer jazzy by Realm . C'est un projet open source. jazzy prend en charge à la fois Objective-C et Swift.
"Le résultat correspond à celui de la documentation de référence officielle d’Apple, publiée après la WWDC 2014." Ce que vous pouvez juger à partir du exemple de doc il fournit.