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 d'aide rapide à générer automatiquement":
Est-ce la fin de la documentation de code manuel comme nous peut apprendre cet article de NSHipster ?
Quelqu'un peut-il décrire les avantages et les inconvénients de cette nouvelle fonctionnalité? Est-ce que cela remplace des outils comme Jazzy ?
Je n'ai pas pu trouver plus d'informations sur la nouvelle fonctionnalité.
Cela fait référence à la fonctionnalité Xcode 8 (et ultérieure), dans laquelle vous pouvez sélectionner une méthode comme celle-ci:
func foo(bar: Int) -> String { ... }
... puis appuyez sur ⌘+option+/ (ou choisissez "Structure" "" Ajouter de la documentation "dans le menu" Editeur "de Xcode) et il générera le modèle de commentaires suivant:
/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>
Cela facilite simplement la rédaction de documentation pour Quick Help.
Notez que bien que ce comportement ait changé un peu avec le temps, Xcode peut indiquer en particulier où le curseur doit se trouver lorsque vous essayez de le faire. Par exemple, pour que cela fonctionne, le curseur doit figurer quelque part dans le nom de la fonction, foo dans mon exemple ci-dessus. Ou double-cliquez simplement sur le nom de la fonction puis appuyez sur ⌘+option+/
Ceci est probablement lié au fait que TOUS les raccourcis clavier avec un '/' ne fonctionnent pas dans la version actuelle de XCode 8, si votre clavier nécessite d'appuyer sur Maj pour l'obtenir.
C'est à dire. sur le clavier allemand, le '/' est shift + 7, appuyer sur alt + cmd + shift-7 ne fait rien. Si vous affectez i.e. cmd + shift + opt + d, cela fonctionne très bien.
Le raccourci '///', qui malheureusement ne fonctionne pas pour le moment, est probablement dû à l'ancien plugin XCode VVDocumenter, qui utilisait exactement ce raccourci.
Fonctionnalité géniale, assurance qualité médiocre du côté Apple.