Créer une entrée "Aide rapide" dans XCode

Question

je voulais vous demander comment je peux créer une aide rapide entrées dans xcode pour mon propre code? j'ai juste envie que de codage, de soutien, de sens comme l'éclipse de la fonctionnalité lors du codage java. dans eclipse, vous obtenez un commentaire que vous avez entré au-dessus d'une méthode lors du survol d'une méthode quelque part d'autre.

xcode équivalent semble être le "prompt secours".

est-il vraiment pas d'autre moyen que d'utiliser doxygen? doxygen semble exagéré pour le petit projet que je suis en train de travailler sur. pour le moment, je ne sais pour sûr que je ne veux l'aide rapide renseigné à fond; donc, s'il vous plaît éviter toute allusion comme "vous avez à créer une documentation pour votre projet".

je serais vraiment reconnaissant de toute aide; que la seule chose sur ce sujet a été

howto créer une Aide Rapide enntry pour des fonctions personnalisées dans XCode

mais comme vous pouvez le voir, aucune solution n'est disponible...

Answer 1

Oui ... vous pouvez .. Voici un "extrait de code" que vous pouvez faire glisser ou compléter automatiquement, etc ...

 /** 
 * <#summary#>
 * @param <#name#> <#how you gonna get it?#>
 * @param <#name#> <#really, there's more?#>
 * @return <#name#> <#what do you want!#>
 */
 

Faites glisser ce "sur" l'extrait "chose" et comme, vous savez .. configurez-le ..

Et voilà...

Answer 2

Je pense que le seul moyen est de créer un Ensemble de la Documentation de votre code, puis l'installer sur XCode:

Xcode 4 est de l'aide contextuelle, qui Apple les appels "Aide Rapide," se fie entièrement à la la documentation installée ensembles. Xcode 4 télécharge automatiquement les la documentation de jeux (y compris les mises à jour) pour Mac OS et iOS Api, mais vous pouvez installer tiers des ensembles.

(...)

Une fois que vous créez votre de la documentation, vous pouvez l'installer dans Xcode préférences (en vertu de la Onglet Documentation). En supposant que le doc ensemble est correctement construit et installé, Aide rapide, il faut "juste travail". De sûr, cela est d'un usage limité, à moins que vous êtes le partage complexe de l'API avec un groupe ou le monde entier.

source: http://xcodebook.com/2011/04/providing-your-own-quick-help/

La Documentation d'Apple Régler le guide: http://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/Documentation_Sets/

Answer 3

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 4

Xcode 5 a maintenant un support intégré pour DOxygen les commentaires de style. Donc, vous pouvez commenter vos méthodes comme ceci:

/*!
 * Provides an NSManagedObjectContext singleton appropriate for use on the main 
 * thread. If the context doesn't already exist it is created and bound to the 
 * persistent store coordinator for the application, otherwise the existing 
 * singleton contextis returned.
 * \param someParameter You can even add parameters
 * \returns The a shared NSManagedObjectContext for the application.
 */
+ (NSManagedObjectContext *)sharedContext;

L'aide en ligne ressemblera à ceci:

Aide rapide ressemblera à ceci:

Et la barre latérale de l'aide ressemblera à ceci:

Voici une représentation d'un extrait de code, vous pouvez ajouter la votre Xcode bibliothèque d'extraits de Code pour faire de documentation de la méthode simple:

/**
 <#description#>
 @param <#parameter#>
 @returns <#retval#>
 @exception <#throws#>
 */

Maintenant, vous pouvez simplement taper "doxy" et hop! Vous avez votre doxygen modèle.

Answer 5

Essayez ce guide Apple pour Doxygen ici et celui-ci pour les documents XCode

Personnellement, je pense qu'il devrait être beaucoup plus simple de le faire dans un IDE moderne.