52 votes

Génération automatique de commentaires de méthodes dans Xcode

Existe-t-il un moyen dans Xcode de générer automatiquement un commentaire de méthode similaire à ce que vous faites dans Eclipse pour les commentaires de javadoc.

Par exemple, vous pouvez frapper /** une ligne avant une déclaration de méthode et eclipse génère automatiquement le squelette des commentaires de méthode.

126voto

Tomas Ivan Points 1242

Vous pouvez utiliser un raccourci pour créer un document d'en-tête :

+ + /

donde
\= Commande
\= Option (Alt sur les claviers compatibles Windows)

3 votes

Exactement ce que je cherchais !

3 votes

Est-ce que quelqu'un sait s'il est possible de passer au commentaire multi-lignes avec \** y *\ Au lieu de la ligne unique ` \\\ ` ? ?

0 votes

Génial, where est facile à comprendre.

29voto

Tim Kemp Points 3515

Vous pouvez utiliser la bibliothèque Code Snippets pour cela. Elle ne génère pas automatiquement des espaces réservés pour chaque paramètre, mais elle est néanmoins très utile. Voici ce que vous devez faire :

  1. Rédigez un exemple de bloc de commentaires dans votre code quelque part.
  2. Insérer <#xyz#> où vous voulez qu'un espace nommé 'xyz' apparaisse. (Ceux-ci sont comme des espaces réservés de complétion de paramètres, vous pouvez donc tabuler entre eux et les écraser).

Par exemple :

/**
 * Method name: <#name#>
 * Description: <#description#>
 * Parameters: <#parameters#>
*/
  1. Ouvrez la barre latérale de droite. Dans le volet inférieur, cliquez sur l'icône des deux accolades pour faire apparaître la bibliothèque de snippets.
  2. Sélectionnez et faites glisser votre texte vers la bibliothèque d'extraits de code.
  3. Ça va en créer un nouveau. Double-cliquez dessus, cliquez sur Modifier dans la fenêtre contextuelle et attribuez-lui un raccourci d'achèvement (par exemple comblk pour le bloc de commentaires).

Désormais, lorsque vous tapez "comblk" n'importe où dans vos éditeurs, la fenêtre de saisie semi-automatique apparaît et vous pouvez appuyer sur "return" pour coller l'extrait. Le premier espace réservé sera sélectionné et vous pourrez commencer à taper le nom de la méthode. Appuyez sur tab pour passer à la description, et ainsi de suite.

Ce n'est pas idéal mais c'est mieux que rien. Les snippets sont une bonne idée qu'Apple n'a pas encore fini de mettre en œuvre.

15voto

yoAlex5 Points 2350

Vous pouvez utiliser une syntaxe de commentaire pour générer une doc.

Editor -> Structure -> Add Documentation
command option /

/// <#Description#>
///
/// - Parameter param: <#param description#>
/// - Returns: <#return value description#>
/// - Throws: <#throws value description#>
func fun(param: String) throws -> String? {
    return false;
}

Référence officielle de formatage du balisage

13voto

pallavi Points 340
  1. Sélectionnez votre code pour lequel vous voulez générer un commentaire et appuyez sur touche de raccourci

    CMD + ALT + /

  2. Le commentaire sera généré automatiquement pour la méthode sélectionnée.

8voto

btate Points 1388

Vous pouvez utiliser ce plugin génial.

https://github.com/onevcat/VVDocumenter-Xcode

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X