Comment utiliser @link et @code en kotlin kDoc

Question

J'essaie de documenter une méthode et j'essaie d'utiliser @link y @code dans le cas de JavaDoc .

Je sais que dans kotlin il y a un kDoc mais je n'arrive pas à les trouver ou du moins quelque chose de similaire.

Answer 1

@link y @code n'existe pas dans kDoc mais peut facilement être remplacé par Balisage en ligne .

de KotlinDoc Liens vers les éléments

Balisage en ligne

Pour le balisage en ligne, KDoc utilise l'option ordinaire Markdown étendu à la syntaxe prendre en charge une syntaxe abrégée permettant d'établir des liens avec d'autres éléments du code.

Liens vers les éléments

Pour établir un lien avec un autre élément (classe, méthode, propriété ou paramètre), il suffit de mettre son nom entre crochets :

Utilisez la méthode [foo] à cette fin.

Si vous voulez spécifier une étiquette personnalisée personnalisé pour le lien, utilisez la syntaxe de style référence Markdown :

Utilisez [this method][foo] à cette fin. Vous pouvez également utiliser des dans les liens. Notez que, contrairement à JavaDoc, les noms qualifiés utilisent toujours toujours le caractère point pour séparer les composants, même avant un nom de méthode. nom :

Utilisez [kotlin.reflect.KClass.properties] pour énumérer les propriétés de la classe. Les noms dans les liens sont résolus en utilisant les mêmes règles que si le nom était utilisé à l'intérieur de l'élément documenté. En particulier, cela Cela signifie notamment que si vous avez importé un nom dans le fichier en cours fichier actuel, vous n'avez pas besoin de le qualifier complètement lorsque vous l'utilisez dans un commentaire KDoc.

Notez que KDoc n'a pas de syntaxe pour résoudre les surcharges. surchargés dans les liens. Puisque l'outil de génération de documentation Kotlin place la documentation de toutes les surcharges d'une fonction sur la même page, l'identification d'une fonction surchargée spécifique n'est pas nécessaire pour que le lien fonctionne. pour que le lien fonctionne.

Answer 2

Pour {@link SomeClass} en Java correspond à [SomeClass] en Kotlin

Pour {@code true} en Java correspond à `true` en Kotlin

Answer 3

Vous pouvez écrire votre code en java et convertir les classes en Kotlin.

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

sera converti en

/**
 * @see [link](http://somelink.com)
 */
class Some

Answer 4

El réponse qu'Artur donne est une bonne indication en général, mais le résultat est faux. En tout cas, IntelliJ IDEA ne comprend pas le résultat. Le format de lien markdown utilisant []() est bien dans le texte principal du commentaire, mais pas pour les liens externes dans le @see tag. Pour cela, vous avez besoin de la même syntaxe qu'en Java :

/**
 * Do something.
 *
 * @see <a href="https://stackoverflow.com/q/45195370/2621917">External links in kdoc</a>
 */

Answer 5

En référence une méthode utiliser le classe :

/**
 * When the configuration succeeds **[MyCallback.onConfigured]** is called.
 */
class MyClass(myCallback: MyCallback) {

Utilisation d'une variable/paramètre ne fonctionne pas :

/**
 * When the configuration succeeds **[myCallback.onConfigured]** is called.
 */
class MyClass(myCallback: MyCallback) {