Créer un commentaire dans Go !

Pourquoi utiliser les commentaires ?

Les commentaires servent à documenter votre code, facilitant ainsi sa compréhension pour vous-même et pour d’autres développeurs. Ils sont particulièrement utiles pour :

Décrire.
Rappeler des informations importantes ou des TODOs pour des améliorations futures.
Désactiver temporairement du code.

En d'autres termes, ce sont des messages, des informations ou du texte qui ne seront pas exécutés par notre programme (ni compilé d'ailleurs).

Syntaxe des Commentaires en Go

En Go, il existe deux types principaux de commentaires : les commentaires sur une seule ligne et les commentaires multi-lignes.

Une seule ligne

Les commentaires sur une seule ligne commencent par //. Tout ce qui suit // sur la même ligne est considéré comme un commentaire et est ignoré par le compilateur.

// Ceci est un commentaire sur une seule ligne
package main

import "fmt"

func main() {
    fmt.Println("Hello, Go!") // Ceci est un commentaire sur une seule
}

Dans cet exemple, les lignes commençant par // sont des commentaires. Vous pouvez les utiliser pour expliquer ce que fait votre code ou pour ajouter des notes.

En général, votre éditeur de code changera la couleur de vos commentaires pour les distinguer du reste du code.

Multi-lignes

Les commentaires multi-lignes commencent par /* et se terminent par */. Tout ce qui se trouve entre ces délimiteurs est considéré comme un commentaire.

/*
    Ceci est un commentaire
    qui s'étend sur plusieurs lignes.
    Il est utile pour des descriptions plus longues ou des explications détaillées.
*/
package main

import "fmt"

func main() {
    fmt.Println("Hello, Go!")
}

Les commentaires multi-lignes sont particulièrement utiles pour documenter des blocs de code ou fournir des explications détaillées.

Bonnes pratiques pour les commentaires

Soyez concis

Les commentaires doivent être clairs et précis. Évitez les commentaires redondants qui répètent simplement ce que le code fait.

Expliquez le pourquoi, pas le comment

Les commentaires doivent généralement expliquer pourquoi quelque chose est fait, pas nécessairement comment c’est fait. Le code lui-même devrait normalement être suffisamment clair pour expliquer le comment.

Mais quelque-fois, il y a des exceptions ! 😁