Comment annoter en langage Go

Méthode de commentaire en langage Go : 1. Implémentez les commentaires sur une seule ligne en plaçant le symbole "//" devant l'instruction go sur une seule ligne. 2. Entourez les parties qui doivent être commentées par "/" Symboles **...*/" Accédez à un extrait de code pour implémenter des commentaires sur plusieurs lignes.

L'environnement de cet article : Système Windows 7, version Go1.11.2, cet article est applicable à toutes les marques d'ordinateurs.

Recommandé : "tutoriel de langage go"

Le rôle des commentaires dans le programme est d'annoter et d'expliquer le programme pour faciliter la lecture du code source. Le système de compilation ignorera automatiquement la partie commentée lors de la compilation du code source, donc les commentaires ne joueront aucun rôle dans la réalisation du fonctionnement du programme. L'ajout approprié de commentaires au code source peut améliorer la lisibilité du code source.

Les commentaires en langage Go sont principalement divisés en deux catégories, à savoir les commentaires sur une seule ligne et les commentaires sur plusieurs lignes.

Les commentaires sur une seule ligne sont appelés commentaires sur une seule ligne, qui constituent la forme de commentaires sur une seule ligne commençant par // peuvent être utilisés n'importe où.

Multi- ; Les commentaires de ligne sont appelés commentaires de bloc, commençant par /. Ils commencent par * et se terminent par */, et ne peuvent pas être imbriqués. Les commentaires sur plusieurs lignes sont généralement utilisés pour les descriptions de documentation de packages ou les extraits de code commentés dans des blocs.

Le format des commentaires sur une seule ligne est le suivant

//单行注释

Le format des commentaires sur plusieurs lignes est le suivant

/*
第一行注释
第二行注释
...
*/

Chaque package doit avoir des commentaires pertinents et utiliser le Instruction package pour déclarer le package Ajoutez les commentaires correspondants avant le nom pour expliquer brièvement les fonctions et les fonctions du package.

Dans le même temps, le contenu du commentaire avant la déclaration du package sera considéré par défaut comme la documentation de ce package. Un package peut être réparti sur plusieurs fichiers, mais un seul d’entre eux doit être commenté.

Vous pouvez utiliser des lignes vides pour séparer plusieurs commentaires, comme indiqué ci-dessous :

// Package superman implements methods for saving the world.
//
// Experience has shown that a small number of procedures can prove
// helpful when attempting to save the world.
package superman

Il est préférable d'ajouter des commentaires correspondants aux variables, constantes, fonctions et autres objets dans le code, ce qui est utile pour une maintenance ultérieure du code, comme les commentaires sur la fonction enterOrbit dans le code suivant :

// enterOrbit causes Superman to fly into low Earth orbit, a position
// that presents several possibilities for planet salvation.
func enterOrbit() error {
   ...
}

Lorsque les développeurs ont besoin de connaître certaines informations sur le package, ils peuvent utiliser godoc pour afficher la documentation du package

Pour plus d'articles techniques connexes, veuillez visiter la colonne tutoriel golang !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!