Description de la méthode Objective-C (doc commentaires)
J'apprends actuellement Objective-C et j'ai besoin de savoir comment écrire une description de méthode. J'ai beaucoup de difficulté à apprendre à le faire dans Objective-C.
Dans Jave nous avons ceci
/**
< h2 >MethodName</ h2 >
< p >Various Description, can use html with images etc.</ p >
*/
private void methodName(args[]..)
{
}
Dans objective-c où puis-je placer la description? Cela se trouve-t-il également dans le fichier d'en-tête ou le fichier d'implémentation?
//Within Implementation?
- (float)gteHeightPercentage:(float)percentageToGet
{
return self.view.bounds.size.height * percentageToGet;
}
//Within Header?
- (float)getWidthPercentage:(float)percentageToGet;
3 réponses
Mise à Jour: Le format ci-dessous fonctionne pour Objc. Si vous souhaitez documenter le code swift, reportez-vous au blog de NSHipster sur la Documentation Swift
Le XCode 5 peut faire ce que vous voulez. Merci à Wonil Kim , dans le .h fichier:
/**
* Add new message between source to destination timeline as empty name string
* @author Wonil Kim
*
* @param sourceId Source timeline entity ID
* @param destId Destination timeline entity ID
* @return A newly created message instance
*/
- (ISMessage*)messageFromTimeline:(NSInteger)sourceId toTimeline:(NSInteger)destId;
Une fois cela fait, vous pouvez alt + cliquer sur le nom de la méthode, et.. voilà!
Bien sûr, comme vous pouvez le voir sur le blog deKim , ce n'est pas le seul façon:
/*! Some description of the method....
* \returns The result
*/
Sinon,
/// Some description to show up, done by:
/// @author Olly Dixon
Vous avez compris...
Comme beaucoup l'ont déjà mentionné, Objective-C ne vous montre pas votre documentation; en fait, java non plus (javadoc, peut-être). C'est votre IDE, dans ce cas, le Xcode Non crashable:)
Mise à jour2: liste complète des "commandes spéciales" dans les commentaires .
UPDATE3: utilisez VVDocumenter-Xcode Si vous souhaitez activer la génération automatique de documentation par ///.
UPDATE4: : VVDocumenter a été intégré à Xcode:
Utilisez le raccourci( Option Option + Command commande+/) pour ajouter une documentation commentez votre code si vous utilisez Xcode 8 ou supérieur
Ce que vous décrivez est appelé "commentaires de documentation", ou" commentaires de doc " pour faire court.
Xcode, à partir de la version 4.6.3, n'affiche pas vos propres commentaires doc dans une fenêtre pop-up ou son inspecteur d'aide rapide. Vous devez compiler vos commentaires dans un "docset" pour que Xcode les affiche. Il existe des outils pour le faire, mais il n'y a aucun moyen D'obtenir Xcode pour recharger un docset sauf en le quittant et en le redémarrant, donc je ne recommande pas de le déranger.
Xcode 5 (qui est actuellement disponible en tant qu'aperçu développeur pour les membres payants des programmes de développement OS X et iOS) est-ce que affiche les commentaires doc pour votre propre code; voir "Aide rapide" sur la page Developer Tools Features . Vous devez écrire les commentaires doc dans le fichier d'en-tête. Vous pouvez utiliser le format doxygen ou headerdoc.
Dans objective-c où puis-je placer la description?
Les compilateurs Objective-C comme gcc et llvm ne se soucient pas de la façon dont vous documentez votre code. Il existe plusieurs générateurs de documentation différents tels que Doxygen et HeaderDoc qui peuvent générer de la documentation à partir de commentaires correctement formatés, généralement dans vos fichiers d'en-tête. De plus, Xcode permet de passer facilement à la définition des symboles définis dans votre code, et c'est l'inspecteur "aide rapide" qui peut vous montrer définitions, les deux sans aucune annotation spéciale dans votre code.