documentation - documentación - kotlin dokka

Cómo usar @link y @code en kotlin kDoc

Question

Estoy tratando de documentar un método y tratando de usar @link y @code como en JavaDoc .

Sé que en Kotlin hay un kDoc pero no puedo encontrarlos o al menos algo similar.

Answer 1

@link y @code no existen en kDoc pero pueden ser reemplazados fácilmente por Inline Markup .

de KotlinDoc que enlaza con los elementos

Marcado en línea

Para el marcado en línea, KDoc utiliza la sintaxis normal de Markdown , extendida para admitir una sintaxis abreviada para vincular a otros elementos en el código.

Enlace a los elementos

Para enlazar con otro elemento (clase, método, propiedad o parámetro), simplemente ponga su nombre entre corchetes:

Utilice el método [foo] para este propósito.

Si desea especificar una etiqueta personalizada para el enlace, use la sintaxis de estilo de referencia de Markdown:

Utilice [this method][foo] para este propósito. También puede utilizar nombres calificados en los enlaces. Tenga en cuenta que, a diferencia de JavaDoc, los nombres calificados siempre usan el carácter de punto para separar los componentes, incluso antes del nombre de un método:

Utilice [kotlin.reflect.KClass.properties] para enumerar las propiedades de la clase. Los nombres en los enlaces se resuelven usando las mismas reglas que si el nombre se usó dentro del elemento que se documenta. En particular, esto significa que si ha importado un nombre al archivo actual, no necesita calificarlo completamente cuando lo usa en un comentario de KDoc.

Tenga en cuenta que KDoc no tiene ninguna sintaxis para resolver miembros sobrecargados en enlaces. Como la herramienta de generación de documentación de Kotlin coloca la documentación para todas las sobrecargas de una función en la misma página, no es necesario identificar una función específica de sobrecarga para que funcione el enlace.