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

85

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

"Création automatique de la documentation d'aide rapide":

entrez la description de l'image ici

Est-ce la fin de la documentation du code manuel comme nous pouvons l'apprendre dans 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é.

xcode swift xcode8 H4Hugo
la source
@Rob: Toute idée de comment je pourrais voir à quoi cela ressemble sans avoir la douleur d'installer Xcode 8 bêta et de le désinstaller juste après (non autorisé à l'installer sur le mac de mon travail)
H4Hugo
C'est démontré dans certaines vidéos de la WWDC 2016.
Rob
1
developer.apple.com/videos/play/wwdc2016/102
Rob
2
Vous pouvez voir une démo dans la vidéo à 37h00 - mais je ne peux pas la faire fonctionner! J'ai essayé avec swift et obj-c et avec différentes parties d'une fonction sélectionnée.
Confused Vorlon

Réponses:

203

Cela fait référence à la fonctionnalité Xcode 8 (et versions ultérieures), où 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« É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 bien que ce comportement ait un peu changé au fil du temps, Xcode peut être particulier sur l'emplacement du curseur lorsque vous essayez de le faire. Par exemple, le curseur doit être quelque part dans le nom de la fonction, foodans mon exemple ci-dessus, pour que cela fonctionne. Ou double-cliquez simplement sur le nom de la fonction, puis appuyez sur ⌘+ option+/

Rob
la source
1
pouvez-vous le faire fonctionner? Je ne peux pas. Si tu peux; que sélectionnez-vous lorsque vous utilisez la commande? J'ai essayé à peu près toutes les options ...
Confused Vorlon
2
Je viens de mettre mon curseur quelque part dans le nom de la méthode, puis appuyez sur commande + option + "/" (ainsi que d'avoir choisi "Editeur" - "Structure" - "Ajouter de la documentation") dans Xcode 8 et cela fonctionne très bien. Le seul problème que j'ai rencontré jusqu'à présent est qu'il semble être confondu avec les @IBActionméthodes. Mais cela fonctionne à la fois avec Objective-C et Swift. Si vous rencontrez toujours des problèmes et que vous avez essayé la procédure boiteuse habituelle de redémarrage de Xcode et / ou de redémarrage de votre machine, vous voudrez peut-être simplement publier un rapport de bogue sur ce logiciel bêta.
Rob
2
J'ai juste essayé un redémarrage, mais toujours pas de joie. J'ai soumis un rapport de bogue.
Confused Vorlon
5
Il fonctionne en fait à partir de Xcode 8 beta 1, mais si vous utilisez El Capitan, vous devez lancer Xcode, le laisser installer les composants système requis, puis l'exécuter sudo /usr/libexec/xpccachectldans Terminal et redémarrer votre Mac avant qu'il ou toute autre extension Xcode ne le fasse. travail. Consultez les notes de mise à jour de Xcode 8.
Chris Hanson
1
Je trouve que cela fonctionne de manière sporadique. Parfois, cela fonctionne très bien et parfois pas du tout. Je n'ai pas non plus découvert pourquoi. Franchement, quand cela fonctionne, je trouve que les choses qu'il génère automatiquement sont plutôt rares (nom de la méthode dans la description?). Pour ceux d'entre vous que cela fonctionne sans problème, génial. Pour certains d'entre nous, cela est sporadique ou ne fonctionne tout simplement pas.
Lloyd Sargent
7

Ceci est probablement lié au fait que TOUTES les touches de raccourci avec un '/' ne fonctionnent pas dans la version actuelle de XCode 8, si votre clavier nécessite 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 attribuez ie cmd + shift + opt + d, cela fonctionne très bien.

Le raccourci '///', qui malheureusement ne fonctionne pas non plus pour le moment, est probablement dû à l'ancien plugin XCode VVDocumenter, qui utilisait exactement ce raccourci.

Grande fonctionnalité, QA moche du côté Apple.

Klaus Busse
la source
Il y avait ce bogue dans Xcode 8 beta mais il a été corrigé dans la version publiée.
Eric Aya
8A218a est la version publiée - et le raccourci de commentaire fonctionne à nouveau pour moi (pas en version bêta).
Eric Aya
Êtes-vous sur une disposition de clavier, où vous obtenez «/» sans utiliser shift?
Klaus Busse
Oui, j'ai deux claviers, un Azerty français avec "/" au dessus de ":" et un Qwerty américain. Les deux fonctionnent bien pour le raccourci de commentaire.
Eric Aya
Bon, c'est intermittent pour moi (clavier américain).
Lloyd Sargent