2016-03-03 18 views
9

W Javadoc Java, istnieje sposób dziedziczenia dokumentacji metody w podklasie przy użyciu {@inheritDoc} tag.Jak dziedziczę dokumentację KDoc?

Czy jest sposób na to samo w KDoc Kotlina?

Zasadniczo, co chciałbym zrobić, jest następujący:

abstract class Base { 
    /** 
    * Some KDoc documentation here. 
    */ 
    abstract fun foo() 
} 

class Derived: Base() { 
    /** 
    * Here is all the documentation from Base#foo's KDoc inherited. 
    * 
    * And here goes something more in addition. 
    */ 
    override fun foo() { /* ... */ } 
} 
+0

robi '' {@inheritDoc} nie działa? Spróbowałeś? – CaseyB

+0

@ CaseyB, tak, zrobiłem, i ani IntelliJ, ani dokka nie rozumie, po prostu pokazują to jako tekst. – hotkey

+2

Nie mogę znaleźć niczego, co udokumentowałoby moje odkrycie, ale z tego, co mogę powiedzieć, Kotlin Doc dziedziczy dokumentację, gdy nadpisuje funkcję, jeśli żadna dokumentacja nie została określona w trybie nadpisywania. Teraz zastanawiam się, jak "rozszerzyć"/"uwzględnić" podstawową dokumentację ... – mfulton26

Odpowiedz

10

Dokka zawsze kopie dokumentacji z elementem podstawy do odziedziczonej jednego czy odziedziczone użytkownik nie posiada własnej dokumentacji. Nie ma sposobu na połączenie dokumentacji podstawowej z dodatkowym tekstem dostarczonym w dziedziczonym elemencie.

(Dokka nie obsługuje znacznika @inheritdoc Javadoc bo to nieuchronnie prowadzi do proliferacji komentarzy zawierających tylko /** @inheritdoc */ co uważam Super bezużyteczne i zbędne.)

+4

Jednak z jakiegoś powodu, gdy wciskam 'Ctrl + Q' na dziedziczoną funkcję bez dokumentacji, to nie pokazuje żadnych, jednak funkcja podstawowa ma to określone i kiedy mam do niej' Ctrl + B' i naciśnięcie 'Ctrl + Q' na funkcji podstawowej, pokazana jest dokumentacja. Może to jakiś błąd ide-plugina. – dimsuz

+1

@ yole Po naciśnięciu skrótu dokumentacji na przesłoniętej metodzie z klasy/interfejsu java, nie widzę dokumentacji, podczas gdy klasa podstawowa/interfejs ma trochę dokumentacji. To naprawdę niewygodne. Czy jest na to otwarty problem? –

Powiązane problemy