Dans cet article, vous découvrirez les commentaires de Kotlin, pourquoi et comment les utiliser.
En programmation, les commentaires font partie du programme destiné à vous et à vos collègues programmeurs pour comprendre le code. Ils sont complètement ignorés par le compilateur Kotlin (Kompiler).
Similaire à Java, il existe deux types de commentaires dans Kotlin
/*… *///… .
Commentaire traditionnel / *… * /
Il s'agit d'un commentaire multiligne qui peut s'étendre sur plusieurs lignes. Le compilateur Kotlin ignore tout de /*à */. Par exemple,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Le commentaire de tradition est également utilisé pour documenter le code Kotlin (KDoc) avec une petite variation. Les commentaires KDoc commencent par /**et se terminent par */.
Commentaire de fin de ligne //
Le compilateur ignore tout de //jusqu'à la fin de la ligne. Par exemple,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // affiche Hello, World! À l'écran)
Le programme ci-dessus contient deux commentaires de fin de ligne:
// Programme Kotlin Hello World
et
// affiche Hello, World! sur l'écran
Utilisez les commentaires de la bonne manière
Les commentaires ne doivent pas remplacer un moyen d'expliquer un code mal écrit en anglais. Écrivez un code bien structuré et lisible, puis utilisez des commentaires.
Certains pensent que le code devrait être auto-documenté et que les commentaires devraient être rares. Cependant, je dois être complètement en désaccord avec cela (c'est mon opinion personnelle). Il n'y a rien de mal à utiliser des commentaires pour expliquer des algorithmes complexes, des expressions régulières ou des scénarios dans lesquels vous avez choisi une technique plutôt qu'une autre (pour référence future) pour résoudre le problème.
Dans la plupart des cas, utilisez des commentaires pour expliquer «pourquoi» plutôt que «comment» et vous êtes prêt à partir.
