Documentation Automatique
Bonjour à tous,
J'ai récemment testé Bluej sur Mac, et j'ai remarqué l'auto-génération d'une documentation. J'ai trouvé ça formidable, mine de rien, et me suis dit que ça pourrait être pratique pour XCode.
Le but est simple, vous sélectionnez un fichier source, et hop, le logiciel vous en sort une documentation au format HTML, grâce à tous les commentaires que vous aurez introduit dans votre code.
Si un tel logiciel n'existe pas déjà , j'aurai aimé connaà®tre la plupart des commentaires réalisables en général (comme //TODO: etc...)
J'ai récemment testé Bluej sur Mac, et j'ai remarqué l'auto-génération d'une documentation. J'ai trouvé ça formidable, mine de rien, et me suis dit que ça pourrait être pratique pour XCode.
Le but est simple, vous sélectionnez un fichier source, et hop, le logiciel vous en sort une documentation au format HTML, grâce à tous les commentaires que vous aurez introduit dans votre code.
Si un tel logiciel n'existe pas déjà , j'aurai aimé connaà®tre la plupart des commentaires réalisables en général (comme //TODO: etc...)
Connectez-vous ou Inscrivez-vous pour répondre.
Réponses
Il existe HeaderDoc fourni par Apple (et intégré à Xcode je crois?), mais il est bien trop simpliste à mon goût (et au goût de beaucoup), ne supportant que peu de balises de doc.
Moi pour ça j'utilise (comme beaucoup, également) doxygen. Tu trouveras ici la doc pour configurer doxygen dans Xcode pour qu'il te génère automatique carrément un DocSet (que tu peux donc ensuite consulter dans la doc Xcode à côté de la doc de l'iPhone SDK, du Mac SDK etc), encore plus sympa à manipuler.
En plus, avec le "Doxygen GUI" (installé quand tu installes doxygen sur Mac), tu n'as pas à faire la configuration en mode texte (en éditant le doxyfile) comme avant, puisque tu as du coup une interface graphique plus compréhensible pour faire tout ça
Si même les anciens oublient la recherche ::)