2016-06-24 73 views
9

Come si generano commenti per i propri metodi/classi? Semplicemente digitando:Generazione di commenti metodo/classe Kotlin

/** 

E spingendo enter non sembra di lavorare in IntelliJ IDEA 2016.1.3

Sembra Dokka è sostituita KDOC, ma perché c'è alcun supporto in IntelliJ? O mi sta sfuggendo qualcosa?

Chiarimento: quando si digita/** + entrare, questo viene generato:

/** 
* 
*/ 

ma mi chiedo il motivo per cui la generazione di @param e altri non vengono aggiunti (come IntelliJ fa per Java) . Queste annotazioni sono utilizzate per la documentazione del codice Kotlin così (https://kotlinlang.org/docs/reference/kotlin-doc.html)

+0

'/' + '*' + '*' + 'ENTER' genera'/** \ n * \ n */'per me nel 2016.1.3. Potresti avere qualche plugin che causa problemi? – mfulton26

+1

Ciao sì, mi dispiace dovrei chiarire che lo genera ma non genera il @ params/@ return documentato qui: https://kotlinlang.org/docs/reference/kotlin-doc.html modifica: aggiunto chiarimento a domanda. – DenEwout

risposta

8

Il @param e altri tag non vengono generati perché lo stile di documentazione consigliata per Kotlin è quello di fare riferimento a nomi dei parametri dal doc commento testo utilizzando la sintassi [foo], piuttosto che per documentarli utilizzando i tag espliciti @param. Puoi controllare lo Kotlin standard library documentation per vedere come viene usato questo stile.

+0

Allora perché la pagina [Documenting Kotlin Code] (https://kotlinlang.org/docs/reference/kotlin-doc.html) ha un elenco di tutti i tag disponibili? Mi manca davvero qualcosa qui? – Daksh

+0

I tag sono disponibili e supportati, ma non _recommended_ per l'uso. – yole

+0

Dovrei chiederti di collegarmi alla documentazione che descrive il processo di documentazione il più dettagliato possibile. Grazie! Per via dell'aspetto del link che ho postato nel mio commento precedente, mi è sembrato che fosse quello che la documentazione ufficiale di Kotlin consiglia di utilizzare. – Daksh