2016-06-24 38 views
9

W jaki sposób generujesz komentarze do swoich metod/zajęć? Po prostu wpisując:Generowanie komentarzy/komentarzy dla metody Kotlin

/** 

i popychając enter nie wydają się działać w IntelliJ IDEA 2016.1.3

Wydaje się Dokka zastąpiła KDOC, ale dlaczego nie ma wsparcia w IntelliJ? Czy może czegoś brakuje?

Wyjaśnienie: po wpisaniu/** + enter, to zostanie wygenerowany:

/** 
* 
*/ 

Ale zastanawiam się dlaczego generowanie @param i inni nie są dodawane (jak IntelliJ robi dla Java) . Adnotacje te służą do dokumentowania kodu Kotlin, jak również (https://kotlinlang.org/docs/reference/kotlin-doc.html)

+0

'/' + '*' + '*' + 'ENTER' generuje dla mnie'/** \ n * \ n */'w 2016.1.3. Czy możesz mieć jakieś wtyczki powodujące problemy? – mfulton26

+1

Cześć tak, przepraszam, że powinienem wyjaśnić, że to generuje, ale nie generuje @ params/@ return udokumentowanych tutaj: https://kotlinlang.org/docs/reference/kotlin-doc.html edytuj: dodano wyjaśnienie do pytanie. – DenEwout

Odpowiedz

8

The @param i inne znaczniki nie są generowane dlatego zalecana styl dokumentacja Kotlin jest nawiązanie do nazw parametrów z tekstu doc ​​komentarz używając składni [foo], zamiast w celu udokumentowania ich za pomocą wyraźnych znaczników @param. Możesz sprawdzić Kotlin standard library documentation, aby zobaczyć, jak ten styl jest używany.

+0

Dlaczego więc strona [Dokumentowanie Kod Kotlin] (https://kotlinlang.org/docs/reference/kotlin-doc.html) zawiera listę wszystkich dostępnych znaczników? Czy naprawdę czegoś tutaj brakuje? – Daksh

+0

Tagi są dostępne i obsługiwane, ale nie są zalecane do użytku. – yole

+0

Będę musiał poprosić o połączenie mnie z dokumentacją opisującą proces dokumentacji tak szczegółowo jak to możliwe. Dzięki! Ponieważ wygląd linku, który zamieściłem w poprzednim komentarzu, wydawało mi się, że taka jest rekomendacja oficjalnej dokumentacji Kotlin. – Daksh