Commentaires en Go

Introduction aux commentaires

Les commentaires jouent un rôle crucial dans la programmation, en offrant des éclaircissements sur le code sans affecter son exécution. Ils aident à rendre le code plus compréhensible pour les autres développeurs (ou pour soi-même dans le futur). Dans le langage Go, il existe plusieurs types de commentaires que nous allons explorer.

Commentaires sur une seule ligne

Les commentaires sur une seule ligne en Go s'écrivent avec deux barres obliques (//). Tout texte qui suit ces barres sur la même ligne sera ignoré par le compilateur. Voici un exemple de ce type de commentaire :

// Ceci est un commentaire sur une seule ligne en Go

Commentaires sur plusieurs lignes

Pour créer des commentaires sur plusieurs lignes, on utilise la syntaxe suivante : on commence avec /* et on termine avec */. Tout le texte entre ces symboles sera ignoré par le compilateur. Voici un exemple :

/*
    Tout ceci est commenté.
    Aucun de ce code ne sera exécuté !
*/

Il est également possible d'utiliser des commentaires sur une seule ligne pour chaque ligne, comme ceci :

// Tout ceci est commenté.
// Rien de cela ne sera exécuté !

Commentaires de documentation

Les commentaires de documentation (ou Doc comments) sont utilisés pour fournir des détails importants sur le programme, comme le nom de l'auteur, la date de création et une description du fonctionnement du programme. Ceux-ci sont souvent placés en haut du fichier. Voici un exemple de Doc comment :

// Nom du fichier  : hello.go
// Description     : Ce programme affiche 'Hello World' à l'écran
// Auteur         : Maheshwaran Dhandapani
// Date           : 11/12/2022

Exemple pratique

Voici un exemple d'un programme qui utilise un commentaire de documentation ainsi que des commentaires sur une seule ligne :

// Nom du fichier  : hello.go
// Description     : Ce programme affiche 'Hello World' à l'écran
// Auteur         : Maheshwaran Dhandapani
// Date           : 11/12/2022
package main
import "fmt"

// Fonction principale du programme
func main() {
    // Affiche un texte à l'écran
    fmt.Println("Hello World!!!")
}