How to annotate in go language

Go language comment method: 1. Implement single-line comments by placing the "//" symbol in front of the single-line go statement; 2. Surround the parts that need to be commented out by "/*...*/" symbols Go code snippet to implement multi-line comments.

Environment of this article: Windows 7 system, Go1.11.2 version, this article is applicable to all brands of computers.

Recommended: "go Language Tutorial"

The role of comments in the program is to annotate and explain the program to facilitate reading of the source code. . The compilation system will automatically ignore the commented part when compiling the source code, so the comments will not play any role in realizing the function of the program. Appropriately adding comments to the source code can improve the readability of the source code.

Comments in Go language are mainly divided into two categories, namely single-line comments and multi-line comments.

Single-line comments are referred to as line comments, which are the most common form of comments. Single-line comments starting with // can be used anywhere;

Multi-line comments are referred to as block comments, starting with / It starts with * and ends with */, and cannot be nested. Multi-line comments are generally used for package documentation descriptions or code snippets that are commented into blocks.

The format of single-line comments is as follows

//单行注释

The format of multi-line comments is as follows

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

Each package should have related comments, and use the package statement to declare the package Add corresponding comments before the name to briefly explain the functions and functions of the package.

At the same time, the comment content before the package statement will be considered as the documentation of this package by default. A package can be spread across multiple files, but only one of them needs to be commented.

You can use blank lines to separate multiple comments, as shown below:

// 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

It is best to add corresponding comments to variables, constants, functions and other objects in the code. , which is conducive to later maintenance of the code, such as the comments on the enterOrbit function in the following code:

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

When developers need to know some information about the package, they can use godoc to display the documentation of the package

For more related technical articles, please visit the golang tutorial column!

The above is the detailed content of How to annotate in go language. For more information, please follow other related articles on the PHP Chinese website!