Comment générer le même type de Doc qu'Apple
Greensource
Membre
Bonsoir! J'aimerais faire les choses proprement et générer une doc claire dès le départ de mon projet. Je sais que Doxygen peu le faire mais franchement je n'aime pas trop, en tout cas je préfère de loin celle qu'Apple fournit avec son API!
Donc je me demandais si c'était possible de faire la même ou si je devais me résoudre à utiliser doxygen?
Merci
Donc je me demandais si c'était possible de faire la même ou si je devais me résoudre à utiliser doxygen?
Merci
Connectez-vous ou Inscrivez-vous pour répondre.
Réponses
Xcode est fourni avec HeaderDoc, et utilise plutôt cet outil (similaire aux outils genre JavaDoc et un peu à doxygen aussi, il faut dire) pour te permettre de générer de la documentation automatiquement.
Tu trouveras un guide utilisateur de HeaderDoc ici. De plus, dans Xcode, dans le menu script (le petit logo représentant un parchemin noir genre icône AppleScript, entre le menu "Window" et "Help") tu as un sous-menu HeaderDoc te permettant d'insérer rapidement et facilement dans ton code des commentaires HeaderDoc destinés à être transformés en documentation.
Après, sur le principe global, c'est tous le même mode de fonctionnement : tu mets des commentaires avant le code de ta fonction, des tes .h ou .m, avec un formalisme donné, et les outils transforment ces commentaires en documentation HTML... Mais c'est souvent hautement configurable (choix du template HTML, de savoir comment transformer tel ou tel commentaire en doc, si tu veux une table des matières ou pas, etc, etc), même si HeaderDoc est il me semble l'outil que préconise (et utilise ?) Apple pour générer les documentations automatiques. Donc qu'on peut supposer que les modèles HTML fournis avec l'outil HeaderDoc sont du même accabit que ceux utilisés par la doc Apple officielle...
Après, personnellement je n'ai jamais eu l'occasion d'utiliser HeaderDoc sur un projet Xcode à moi, donc je ne pourrais pas trop te donner de feedback... je te laisse regarder la doc de ce côté.
J'ai bien fait de poser la question, merci.
Et sinon tu utilise quoi toi pour faire ta doc?
Faudrait à l'occasion que je me lance dans un gros projet Xcode que je teste HeaderDoc voir ce qu'il donne, pour l'instant je suis jamais allé jusque là .
Par contre j'ai un truc assez étrange qui se produit. Un souci d'encodage des caractères. Mes sources sont toutes en UTF-8, headerdoc semble prendre en input des fichier encodé en UTF-8 et pourtant à la sortie html, j'ai des caractères accentué qui sont erroné.
à‰trange n'est ce pas?
Mais j'ai quelques souci encore,
1- Je ne trouve pas le fichier de conf et du coup c'est pas terrible le rendu final.
2- C'est pas vraiment un souci, mais je me demandais où trouver un endroit où des gens utilise ce soft? Je vais faire un google search mais si vous savez quelques choses, je vous écoute
http://developer.apple.com/mac/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html
et une petite application qui simplifie sont emploi:
http://kyle.snowmintcs.com/downloads/HeaderDocUI.dmg
Pour les accents si tu as la solution, se serait cool de partager...
Sinon merci pour avoir lancer ce sujet.
Après, pour HeaderDoc, j'avais l'impression qu'il avait des limitations, genre bien moins complet que doxygen car bien moins mature / plus jeune, donc je demande à voir.