web-dev-qa-db-fra.com

Commencez automatiquement Commentaire sur Xcode

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

Par exemple, appuyez sur Vous pouvez toucher/** une ligne avant une déclaration de méthode et Eclipse génère automatiquement le squelette des commentaires de la méthode.

xcodemethodscomments
37
Laszlo

Vous pouvez utiliser la bibliothèque des extraits de code pour cela. Il ne générera pas automatiquement d'espaces réservés pour chaque paramètre, mais il est néanmoins utile. Voici ce que vous faites:

  1. Écrivez un exemple de bloc de commentaire dans votre code quelque part.
  2. Insérer <#xyz#> Où vous voulez qu'un espace réservé nommé 'XYZ' apparaisse. (Celles-ci sont comme des espaces réservés d'achèvement des paramètres, de sorte que vous pouvez l'entre eux et les écraser.)

Par exemple:

/**
 * Method name: <#name#>
 * Description: <#description#>
 * Parameters: <#parameters#>
*/
  1. Ouvrir la barre latérale droite. Dans le volet inférieur, cliquez sur l'icône des deux bretelles bouclées pour afficher la bibliothèque des extraits.
  2. Sélectionnez et faites glisser votre texte dans la bibliothèque des extraits de code.
  3. Ça va créer un nouveau. Double-cliquez dessus, cliquez sur Modifier dans la fenêtre contextuelle et donnez-lui un raccourci d'achèvement (E.G. COMBLK pour le bloc de commentaires.)

Maintenant, lorsque vous tapez "COMBLK '" n'importe où dans vos éditeurs, la fenêtre contextuelle Autocomplete apparaît et vous pouvez frapper le retour à Coller dans l'extrait. Le premier exploitant sera sélectionné et vous pouvez commencer à taper le nom de la méthode. Appuyez sur Tab pour passer à la description, etc.

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

27
Tim

Vous pouvez utiliser un raccourci pour Créer une en-tête DOC:

⌘ + ⌥ + /

où
⌘ = Commande
⌥ = Option (claviers compatibles Alt sur Windows)

93
Tomas Ivan

  1. Sélectionnez votre code pour lequel vous souhaitez générer un commentaire et appuyez sur la touche de raccourci.

    cmd + alt + /

  2. Le commentaire sera autogogenéré pour une méthode sélectionnée.

12
pallavi

Vous pouvez utiliser ce plugin génial.

https://github.com/onevcat/vvdocumenter-xcode

8
smokingoyster

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

Presse ⌘ command+⌥ option+/ ou Editor -> Structure -> Add Documentation

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

En savoir plus Référence de formatage du marquage

3
yoAlex5