Saltar al contenido

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

Solución:

@link y @code no existe en kDoc pero puede ser reemplazado fácilmente por Inline Markup.

de KotlinDoc Vinculación a elementos

Marcado en línea

Para el marcado en línea, KDoc usa la sintaxis regular de Markdown, ampliada para admitir una sintaxis abreviada para vincular a otros elementos del código.

Vinculación a elementos

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

Usa 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:

Usar [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:

Usar [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 usara dentro del elemento que se documenta. En particular, esto significa que si ha importado un nombre en el 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. Dado que la herramienta de generación de documentación de Kotlin coloca la documentación de todas las sobrecargas de una función en la misma página, no es necesario identificar una función sobrecargada específica para que el enlace funcione.

Puede escribir su código con Java y convertir la clase en Kotlin.

/**
 * @see <a href="http://somelink.com">link</a>
 */
public class Some {
}

será convertido a

/**
 * @see https://newbedev.com/how-to-use-link-and-code-in-kotlin-kdoc
(http://somelink.com)
 */
class Some

Para {@link SomeClass} en Java se asigna a [SomeClass] en Kotlin

Para {@code true} en Java se asigna a “verdadero” en Kotlin

¡Haz clic para puntuar esta entrada!
(Votos: 0 Promedio: 0)



Utiliza Nuestro Buscador

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *