2016-06-24 12 views
9

Wie generieren Sie Kommentare für Ihre Methoden/Klassen? Einfach eingeben:Generieren von Kotlin-Methode/Klassenkommentare

/** 

Und drückt enter scheint nicht 2016.01.03 in IntelliJ IDEA zu arbeiten

Es ist wie Dokka scheint hat abgelöst KDOC, aber warum gibt es keine Unterstützung in IntelliJ? Oder fehlt mir etwas?

Klarstellung: bei der Eingabe in/** + eingeben, das generiert wird:

/** 
* 
*/ 

Aber ich frage mich, warum die Erzeugung von @param und andere sind nicht hinzugefügt (wie IntelliJ tut für Java) . Diese Anmerkungen werden für die Dokumentation Kotlin-Code als auch verwendet (https://kotlinlang.org/docs/reference/kotlin-doc.html)

+0

'/' + '*' + '*' + 'ENTER' erzeugt'/** \ n * \ n */'für mich in 2016.1.3. Könnten Sie Probleme mit dem Plugin haben? – mfulton26

+1

Hi ja, tut mir leid, ich sollte klarstellen, dass es generiert, aber es erzeugt nicht die @ params/@ Rückkehr dokumentiert hier: https://kotlinlang.org/docs/reference/kotlin-doc.html edit: zusätzliche Klarstellung zu Frage. – DenEwout

Antwort

8

Die @param und andere Tags werden nicht erzeugt, da die empfohlene Dokumentation Stil für Kotlin ist auf Parameternamen beziehen von der doc Kommentartext mit der [foo] Syntax, anstatt um sie mit expliziten @param Tags zu dokumentieren. Sie können die Kotlin standard library documentation überprüfen, um zu sehen, wie dieser Stil verwendet wird.

+0

Warum hat die Seite [Documenting Kotlin Code] (https://kotlinlang.org/docs/reference/kotlin-doc.html) eine Liste aller verfügbaren Tags? Fehle ich hier wirklich etwas? – Daksh

+0

Die Tags sind verfügbar und werden unterstützt, aber nicht _recommended_ zur Verwendung. – yole

+0

Ich müsste Sie bitten, mich mit der Dokumentation zu verbinden, die den Dokumentationsprozess so detailliert wie möglich beschreibt. Vielen Dank! Weil ich aufgrund des Aussehens des Links, den ich in meinem vorherigen Kommentar gepostet habe, es mir schien, dass dies die offizielle Kotlin-Dokumentation zu empfehlen ist. – Daksh