2014-06-08 15 views
10

Esiste un modo standard per scrivere il commento della documentazione nella lingua Swift? Qualcosa di equivalente a javadoc (Java) o docstrings (Python)?Commento alla documentazione standard Swift

esempio:

/** 
* My docstring example 
* @return the String "foo" 
*/ 
func foo() -> String { 
    return "Foo" 
} 
+0

Vedi http://nshipster.com/swift-documentation/ – Rob

+0

Eventuali duplicati di [ Swift ha commenti o strumenti di documentazione?] (Http://stackoverflow.com/questions/24047991/does-swift-have-documentation-comments-or-tools) – Kevin

risposta

0

Non credo Swift supporta tale. Almeno non è menzionato da nessuna parte.

13

Sì, c'è.

Swift include la gestione dei commenti "///" (anche se probabilmente non è ancora tutto).

scrivere qualcosa di simile:

/// Hey! 
func bof(a: Int) { 

} 

quindi l'opzione-clic sul nome func e voilà :)

+0

Questa è la risposta giusta. ** Ferenc Kiss ** ha dato Parole chiave, come ': param:' e ': restituisce:' funziona, ma dentro '///'. –

0

Credo Apple sta ancora cambiando la sintassi. Sembra che tutte le parole chiave @ non siano implementate da Xcode 6b2, ma per il resto è uguale a ObjC.

Quindi, qualcosa di simile a quello che hai potrebbe funzionare:

/** 
* I am a function. 
*/ 
func randomFn() {} 

Anche se sembra che Swift si ferma per allineare i * s. Naturalmente, non si ha realmente bisogno le stelle, tranne il primo e l'ultimo, in modo da poter fare questo:

/* 
    I am a function. 
*/ 
func randomFn() {} 

Entrambi saranno prelevati dal commento parser in modo che quando si 3 dita clic sul nome della funzione vedrai il suo documento.

@param, @return ha funzionato per la beta1 ma non per la beta2 e tali parole chiave bloccano molto il parser in beta1, suggerendo che Apple non ha ancora completato l'implementazione.

2

MODIFICA: questa soluzione non funziona con Swift 2.0.

Soluzione OLDER work until swift 1.2:
Attualmente sto provando il rapido linguaggio e strumento di documentazione. Xcode è molto sensibile al rientro del testo. Le parole chiave devono iniziare nello stesso posto. Le parole chiave devono essere inserite tra due punti, ad esempio ": restituisce:" Se xcode non viene riconosciuto come parola chiave, Xcode inserisce il testo nella descrizione.

Da questo:

/** 
    Keresés után le lehet kérdezni egy konkrét találatot, pl. ha a harmadikra vagyunk mondjuk kíváncsiak. 

    :note: n-1 legyen az \p index értéke, mert tömb révén a 0. elemmel keződik a tömb. 
    :param: aSearchName Keresés meghatározásánál megadott név. 
    :returns:    Konkrét találat. Ha nincs találat, akkor üres stringgel tér vissza a függvégy. 
    :pre:    `aSearchName` != nil && !\p aSearchName != "" 
    */ 

sarà:

enter image description here

+0

Questa è una risposta parziale. '/ * * /' non funziona. , come ': param:', ': restituisce:' funziona, ma dentro '///' come ** Jean Le Moignan ** m indicato qui sotto. –

+0

Inizia con '/ **' not '/ *'. –

+0

Sfortunatamente, questo non funziona. –

0

potete vedere attuale standard di documentazione qui: http://nshipster.com/swift-documentation/

Esempio:

/** 
    Lorem ipsum dolor sit amet. 

    - parameter bar: Consectetur adipisicing elit. 

    - returns: Sed do eiusmod tempor. 
*/ 

Questo funziona per me. Xcode 7.2

3

Esistono due tipi di Commenti di documentazione riga singola "/// ..."E multilinea "/**...*/" documentazioni NSHipster explains it here

codice di esempio copiato dal sito web:

/** 
    Repeats a string `times` times. 

    - Parameter str: The string to repeat. 
    - Parameter times: The number of times to repeat `str`. 

    - Throws: `MyError.InvalidTimes` if the `times` parameter 
     is less than zero. 

    - Returns: A new string with `str` repeated `times` times. 
*/ 

func repeatString(str: String, times: Int) throws -> String { 
    guard times >= 0 else { throw MyError.InvalidTimes } 
    return Repeat(count: 5, repeatedValue: "Hello").joinWithSeparator("") 
} 
Problemi correlati