Comment vous documenter votre code source dans Xcode ?

Question

Je suis un développeur Mac avec une très solide expérience de Java. J’ai documenté mes sources à l’aide de Javadoc, beaucoup.

• Quel est le moyen d’aller avec le cacao et Xcode ?
• Y a-t-il des outils de documentation fournis avec les outils de développement d’Apple ?
• Est Doxygen le chemin à parcourir ? Quelles sont les alternatives ?

Answer 1

Il y a un projet open-source Appledoc qui peut générer des documentations ressemble documentations officielles d’Apple.

https://github.com/Tomaz/appledoc

Answer 2

Xcode 5, a mis à niveau rapide de l'aide: Désormais, vous pouvez documenter votre code dans vos commentaires comme avec javadoc. Lorsque vous cliquez sur la documentation de l'objet, de méthode, tout en appuyant sur option ⌥, il vous sera présenté avec vos commentaires dans un joli popup comme la documentation d'Apple:

Il est enrôlé dans la liste des fonctionnalités plus ici. Message Original ici.

Answer 3

Si vous utilisez Xcode ≥ 3,0, vous voudrez probablement consulter Doxygen, comme d’autres l’ont suggéré, puis lire cet article sur le site développeur d’Apple pour la création de Xcode documentation définit pour votre projet (visible dans le système d’aide de Xcode) en utilisant Doxygen.

Answer 4

Selon moi, aucun d'entre eux n’est assez bon et docs générés par eux ne sont pas conformes aux normes d’Apple. Alors j’ai signalé un bogue à Apple pour demander un outil de génération de documentation native dans Xcode, s’il vous plaît Votez pour lui si vous souhaitez également un tel outil.