Xcode: affiche la documentation de mes classes personnalisées

Question

Comment puis-je la force de XCode pour montrer ma propre documentation pour les classes personnalisées, des méthodes, etc.? Je suis habitué à Java et Eclipse, qui me montre la documentation pour mes cours, comme illustré ici:

Comment puis-je obtenir le même dans XCode? Y at-il des commentaires que XCode permet de reconnaître et d'affichage?

Answer 1

Comme de Xcode 5.0, Doxygen et HeaderDoc mise en forme pour les variables et les méthodes d'analyse automatiquement et rendu dans l'Aide Rapide liste. Plus d'informations à ce sujet ici, mais voici quelques clés bits:

/**
 * 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:

Comme pour les propriétés, c'est aussi simple que:

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

Quand l'option-clic, cette belle liste s'affiche:

Answer 2

Eh bien, il semble que la question n’ait toujours pas trouvé de réponse pour les classes, je vais donc poster 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:

Answer 3

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 jeux de documents qui fonctionnent très bien pour les popups dont vous parlez. Appledoc n'est pas parfait, mais nous y sommes passés et nous sommes vraiment satisfaits des résultats.

Answer 4

Pour que Xcode affiche la documentation de vos classes, vous devez créer un ensemble 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 la documentation de Xcode. Apple a publié un article sur l'utilisation de Doxygen, mais il couvre Xcode 3 et non 4.

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