Documentation d’aide rapide générée automatiquement par Xcode 8

Parmi les nouvelles fonctionnalités annoncées dans Xcode 8 , on peut voir

“Documentation rapide de l’aide rapide”:

entrer la description de l'image ici

Est-ce la fin de la documentation du code manuel comme nous pouvons en apprendre sur cet article de NSHipster ?

Quelqu’un peut-il décrire les avantages et les inconvénients de cette nouvelle fonctionnalité? Remplace-t-il des outils comme Jazzy ?

Je n’ai pas pu trouver plus d’informations sur la nouvelle fonctionnalité.

Ils disent simplement que dans Xcode 8, vous pouvez sélectionner une méthode comme celle-ci:

func foo(bar: Int) -> Ssortingng { ... } 

Ensuite, appuyez sur commande + option + / ou choisissez “Structure” – “Ajouter une documentation” dans le menu “Éditeur” de Xcode, et il générera le modèle de commentaires suivant pour vous:

 /// <#Description#> /// /// - parameter bar: <#bar description#> /// /// - returns: <#return value description#> 

Cela facilite simplement la rédaction de la documentation pour l’aide rapide.


Notez que, même si ce comportement a changé un peu au fil du temps, Xcode peut indiquer en particulier où doit se trouver le curseur lorsque vous tentez de le faire. Par exemple, le curseur doit être quelque part dans le nom de la fonction, foo dans mon exemple ci-dessus, pour que cela fonctionne. Ou double-cliquez simplement sur le nom de la fonction, puis appuyez sur la commande + option + /

Ceci est probablement lié au fait que TOUS les raccourcis avec un ‘/’ ne fonctionnent pas dans la version XCode 8 actuelle, si votre clavier a besoin d’appuyer sur shift pour l’obtenir.

C’est-à-dire que sur le clavier allemand, le ‘/’ est shift + 7, appuyer sur alt + cmd + shift-7 ne fait rien. Si vous atsortingbuez par exemple cmd + shift + opt + d, cela fonctionne très bien.

Le raccourci ‘///’, qui ne fonctionne malheureusement pas pour le moment, est probablement dû à l’ancien plug-in XCode VVDocumenter, qui utilisait exactement ce raccourci.

Excellente fonctionnalité, QA moche du côté d’Apple.