Xcode: affiche la documentation pour mes classes personnalisées

Comment puis-je forcer Xcode à afficher ma propre documentation pour les classes, méthodes, etc. personnalisées? Je suis habitué à Java et à Eclipse, qui montre la documentation de mes cours, comme indiqué ici:

Eclipse montrant la documentation Javadocs

Comment puis-je obtenir la même chose dans Xcode? Y at-il des commentaires spéciaux que Xcode peut reconnaître et afficher?

Xcode montrant la documentation générique pour NSObject

À partir de Xcode 5.0, le formatage Doxygen et HeaderDoc pour les variables et les méthodes est automatiquement analysé et rendu dans le popover Quick Help. Plus d’informations à ce sujet ici , mais voici quelques éléments clés:

/** * Add a data point to the data source. * (Removes the oldest data point if the data source contains kMaxDataPoints objects.) * * @param aDataPoint An instance of ABCDataPoint. * @return The oldest data point, if any. */ - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

rend dans Xcode comme:

En ce qui concerne les propriétés, c’est aussi simple que:

 /// Base64-encoded data. @property (nonatomic, strong) NSData *data;

Lorsque vous avez cliqué sur cette option, cette jolie popover apparaît:

Eh bien, il semble que pour les cours, la question n’a pas encore reçu de réponse, alors je posterai mes suggestions.

Juste avant la ligne @interface MyClass : NSObject dans le fichier MyClass.h, vous utilisez le commentaire comme vous l’avez fait dans votre exemple, mais en ajoutant des balises pour afficher le texte. Par exemple le code ci-dessous:

 /** * @class GenericCell * @author Average Joe * @date 25/11/13 * * @version 1.0 * * @discussion This class is used for the generic lists */

produira la sortie suivante: la sortie du code ci-dessus http://imageshack.com/a/img18/2194/kdi0.png

Appledoc est la meilleure option pour générer de la documentation xcode pour le moment. Doxygen est génial, mais il ne génère pas de detsets qui fonctionnent très bien pour les popups dont vous parlez. Appledoc n’est pas parfait, mais nous y sums allés et avons été très satisfaits des résultats.

entrer la description de l'image ici

Il est également possible d’append un extrait de code dans la documentation comme suit:

Extrait de code dans la documentation de la fonction dans Xcode

en ajoutant le code suivant

  * @code * - (UIButton*) createButtonWithRect:(CGRect)rect { // Write your code here } * @endcode

Pour plus de détails sur les méthodes de documentation d’une classe personnalisée, vous pouvez consulter la documentation de mon blog dans Xcode .

Pour que Xcode affiche la documentation de vos classes, vous devez créer un jeu de documentation pour vos classes à l’aide d’un outil tel que Doxygen ou HeaderDoc. Après avoir créé le jeu de documentation, vous devez l’installer en utilisant les préférences de documentation de Xcode. Apple a un article sur l’utilisation de Doxygen, mais il couvre Xcode 3, pas 4.

Utilisation de Doxygen pour créer des ensembles de documentation Xcode