2010-08-19 4 views
2

Je me demande quel outil peut être utilisé dans Xcode pour générer la documentation d'un projet iPhone, donc écrit principalement en Objective-C et C, mais aussi en aidant à la conception du code. Les documents que je voudrais être produit sont:Quels outils puis-je utiliser pour générer de la documentation pour un projet Xcode?

  • diagrammes de classe comme UML (avec généralisation, agrégation et relations composition)
  • composants comme diagramme UML
  • diagramme de séquence comme UML

Je connais deux outils sympas: Doxygen (que je n'utilisais pas dans Xcode) un HeaderDoc (qui ressemble à Doxygen mais n'intègre pas les facilités de génération de graphes doux fournis avec GraphViz dans DoxyGen). Mais ce sont des outils automatisés et sont centrés sur les fichiers/classes. Une suggestion sur un autre outil utile?

MISE À JOUR: Si elle est toujours pas clair (lol, j'ai vu le changement de titre à nouveau), je voudrais générer la documentation mais le projet est non seulement « de » un (xcode) mais aussi « pour » : par exemple, planifier comment structurer son architecture et la concevoir en utilisant un diagramme de composants/configuration. J'espère trouver quelque chose qui s'intègre bien avec l'IDE (quelque chose comme la multitude de plugins que vous voyez pour Eclipse)

+0

@Mark Trapp: Pourquoi avez-vous supprimé 'Xcode' du titre? J'aimerais connaître les outils qui s'intègrent à l'EDI, comme la multitude de plugins Eclipse pour la modélisation. – rano

+1

Votre question est déjà étiquetée xcode: vous n'avez pas non plus besoin d'étiqueter le titre. Voir: http://meta.stackexchange.com/questions/61055/when-should-we-remove-pseudo-tags-from-a-title –

+0

@Mark Trapp: excusez-moi, mais je ne comprends toujours pas, http://meta.stackexchange.com/questions/10647/howto-writing-good-titles dit que pointer la balise principale (pas seulement quand cela peut changer le contexte) est une bonne pratique – rano

Répondre

6

Puisque vous êtes à l'aise avec Doxygen et qu'il a les fonctionnalités dont vous avez besoin, respectez-le. Voir guide d'Apple sur la production de jeux de documentation Xcode à partir de projets Doxygen. Le projet CorePlot est un bon exemple de using Doxygen dans un projet Xcode.

+1

Vous voudrez peut-être signaler que Core Plot est un bon exemple de génération de documentation pour un framework utilisant Doxygen: http://code.google. com/p/core-plot/wiki/DocumentationPolicy –

+1

@Brad Je suis gêné de ne pas avoir profité de l'occasion pour lancer Core Plot: un super projet (même si je suis un peu biaisé), et un phare de lumière sur la colline pour une gamme de meilleures pratiques (y compris la documentation). –

+0

+1 à vous deux, je vais sûrement jeter un oeil, mais je cherche maintenant quelque chose pour m'aider à concevoir mon logiciel, avant de commencer à écrire du code, qui sera utilisé comme documentation plus tard – rano

Questions connexes