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

Question

Parmi les nouvelles fonctionnalités annoncées dans Xcode 8, nous pouvons voir

"Auto-générer Rapidement de la documentation d'Aide" :

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

Quelqu'un peut-il décrire les avantages et les inconvénients de cette nouvelle fonctionnalité ? Il ne remplacera pas des outils comme Jazzy ?

Je ne pouvais pas trouver plus d'informations sur la nouvelle fonction.

Answer 1

Ils sont juste de dire que, dans Xcode 8, vous pouvez sélectionner une méthode comme ceci:

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

Appuyez sur commande+option+/ ou de choisir une "Structure" - "Ajouter de la documentation" de Xcode "Éditeur" dans le menu, et il va générer les commentaires suivants au modèle qu'il vous faut:

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

Il facilite simplement la rédaction de la documentation d'Aide Rapide.

---

Remarque, alors que ce comportement a un peu changé au fil du temps, Xcode peut être particulier sur l'endroit où le curseur doit être 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 commande+option+/

Answer 2

Ceci est probablement lié au fait que TOUS les raccourcis avec un '/' ne travaille pas dans le courant de XCode 8 construire, si votre clavier nécessite d'appuyer sur shift pour l'obtenir.

I. e. sur le clavier allemand, le " / " est maj+7, en appuyant sur alt+cmd+maj-7 ne pas faire une chose. Si vous attribuez à savoir cmd+maj+option+d, il fonctionne très bien.

Le raccourci '///', qui malheureusement ne fonctionne pas maintenant, est probablement due à l'ancien XCode plugin VVDocumenter, qui a utilisé exactement ce raccourci.

Grande fonctionnalité, moche QA sur le côté d'Apple.