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

J'ai lutté un peu avec cela avec Android Studio 3.5.2 sur Mac. Ceci a fonctionné pour moi :

/**
* [Your fully-qualified class name.function name]
*/

Si je n'utilisais pas le nom entièrement qualifié, Kdoc se plaindrait qu'il s'agit d'une référence non résolue. Ce que je n'ai pas réussi à comprendre, c'est comment utiliser le lien lui-même. Pour cela, vous devez appuyer sur la touche COMMAND (sur Mac) et la maintenir enfoncée, et les liens seront alors actifs.

Answer 2

Quant à la @code vous devez utiliser Syntaxe Markdown (car KDoc est une version étendue de Markdown) :

Pour produire un bloc de code en Markdown, il suffit d'indenter chaque ligne du bloc d'au moins 4 espaces ou 1 tabulation.

/**
 * Some code sample:
 * 
 *    Set<String> s;
 *    System.out.println(s);
 */
class Scratch

Answer 3

Il semble que nous devrions simplement utiliser un lien hypertexte markdown sans aucune balise spéciale telle que @see ou @link :

/**
 * This is a doc.
 *
 * See [this](https://google.com)
 * And [this](https://stackoverflow.com)
 */
fun myfun() {}

Ce document est rendu de la manière suivante dans l'IDE :

Answer 4

Exemple de comment laisser des liens pour les classes :

/**
 * [YourClass] Methods
 * */

également avec des appels de méthode

/**
 * [YourClass.someMothod] Methods
 * */

---

Exemple concret :

 /**
 * [BaseActivity] Methods
 * */
override fun initVars() {
    //Just Sample
}

/**
 * [MainContract.View] - Overrides
 * */
override fun handleConnectionMassage(isShow: Boolean) {
    //Just Sample
}