Documentazione di guida rapida generata automaticamente da Xcode 8


85

Tra le nuove funzionalità annunciate in Xcode 8 , possiamo vedere

"Genera automaticamente documentazione della Guida rapida":

inserisci qui la descrizione dell'immagine

È questa la fine della documentazione del codice manuale come possiamo imparare in questo articolo da NSHipster ?

Qualcuno può delineare i pro ei contro di questa nuova funzionalità? Sostituisce strumenti come Jazzy ?

Non sono riuscito a trovare ulteriori informazioni sulla nuova funzione.


@Rob: Qualche idea di come potrei vedere come appare senza avere il dolore di installare Xcode 8 bêta e disinstallarlo subito dopo (non autorizzato a installarlo sul Mac del mio lavoro)
H4Hugo

È dimostrato in alcuni video del WWDC 2016.
Rob il


2
Puoi vedere una demo nel video alle 37:00, ma non riesco a farlo funzionare davvero! Ho provato con swift e obj-c e con varie parti diverse di una funzione selezionata.
Confuso Vorlon

Risposte:


204

Questo si riferisce alla funzionalità Xcode 8 (e successive), in cui è possibile selezionare un metodo come questo:

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

... e poi premi + option+ /(o scegli "Struttura" »" Aggiungi documentazione "dal menu" Editor "di Xcode) e genererà il seguente modello di commenti per te:

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

Facilita solo la scrittura della documentazione per la Guida rapida.


Nota, sebbene questo comportamento sia leggermente cambiato nel tempo, Xcode può essere particolare su dove deve essere il cursore quando si tenta di farlo. Ad esempio, il cursore deve trovarsi da qualche parte nel nome della funzione, foonel mio esempio precedente, affinché funzioni. Oppure fai doppio clic sul nome della funzione e quindi premi + option+/


1
puoi farlo funzionare? Non posso. Se puoi; cosa stai selezionando quando usi il comando? Ho provato quasi tutte le opzioni ...
Confuso Vorlon

2
Ho appena posizionato il cursore da qualche parte nel nome del metodo e poi ho premuto command + option + "/" (oltre ad aver scelto "Editor" - "Structure" - "Add documentation") in Xcode 8 e funziona bene. L'unico problema che ho riscontrato finora è che sembra essere confuso con i @IBActionmetodi. Ma funziona bene sia con Objective-C che con Swift. Se hai ancora problemi e hai provato la solita procedura zoppa di riavviare Xcode e / o riavviare la tua macchina, potresti semplicemente voler pubblicare una segnalazione di bug su questo software beta.
Rob

2
Ho appena provato a riavviare, ma ancora nessuna gioia. Ho inviato una segnalazione di bug.
Confused Vorlon,

5
In realtà funziona a partire da Xcode 8 beta 1, ma se stai usando El Capitan devi avviare Xcode, lasciarlo installare i componenti di sistema richiesti, quindi eseguire sudo /usr/libexec/xpccachectlin Terminale e riavviare il tuo Mac prima di esso o qualsiasi altra estensione Xcode. lavoro. Consulta le note sulla versione di Xcode 8.
Chris Hanson

1
Trovo che funzioni sporadicamente. A volte funziona alla grande e altre volte per niente. Né ho scoperto perché. Francamente, quando funziona, trovo che le cose che genera automaticamente siano piuttosto scarse (nome del metodo nella descrizione?). Per quelli di voi che funziona senza problemi, fantastico. Per alcuni di noi è sporadico o semplicemente non funziona.
Lloyd Sargent

7

Ciò è molto probabilmente correlato al fatto che TUTTI i tasti di scelta rapida con un '/' non funzionano nell'attuale build di XCode 8, se la tua tastiera richiede di premere Shift per ottenerlo.

Cioè sulla tastiera tedesca la "/" è shift + 7, premere alt + cmd + shift-7 non fa nulla. Se assegni ie cmd + shift + opt + d, funziona bene.

La scorciatoia "///", che purtroppo anche al momento non funziona, è probabilmente dovuta al vecchio plugin XCode VVDocumenter, che utilizzava esattamente questa scorciatoia.

Grande funzionalità, pessimo controllo di qualità sul lato Apple.


C'era questo bug nella beta di Xcode 8 ma è stato corretto nella versione rilasciata.
Eric Aya

8A218a è la versione rilasciata - e la scorciatoia per i commenti funziona di nuovo per me (non nelle beta).
Eric Aya

Sei su un layout di tastiera, dove ottieni "/" senza usare maiusc?
Klaus Busse

Sì, ho due tastiere, una francese dell'Azerty con "/" sopra ":" e una americana Qwerty. Entrambi funzionano bene per la scorciatoia per i commenti.
Eric Aya,

Bene, è intermittente per me (tastiera americana).
Lloyd Sargent
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.