How to comment multiple lines in go language

In the go language, you can use the multi-line comment character "/**/" to comment multiple lines of code. Multi-line comments (referred to as block comments) start with "/*" and end with "*/" at the end, and it cannot be nested. The syntax is "/*comment content...*/"; Line comments are typically used to document package descriptions or to comment code snippets into blocks.

The operating environment of this tutorial: Windows 7 system, GO version 1.18, Dell G3 computer.

In the Go language, you can use one or more lines ending with the multi-line comment symbol "/**/" to comment multiple lines of code.

What do comments mean

Comments are explanations and descriptions of the code, and their purpose It allows people to understand the code more easily. Comments are when the programmer writes an explanation or hint for a statement, program segment, function, etc., which can improve the readability of the program code.

Comments The function in the program is to annotate and explain the program to facilitate reading of the source code. The compilation system will automatically ignore the comment part when compiling the source code, so the comment has no effect on the function realization of the program. In the source code Appropriately adding comments can improve the readability of the source code.

No matter what programming language is used, adding comments to the code is necessary. Most projects require a period of time to complete development and testing, and finally After going online, we still have to deal with iterative updates of the product. However, it is no exaggeration to say that even if it is only a week apart, we may not be able to understand the code, even if the code is written by ourselves. At this time, comments can help us very well Understand these codes.

Multi-line comments in go language

Multi-line comments are referred to as block comments, and the format is /*# Start with ## and end with */, and cannot be nested. Multi-line comments are generally Used for documentation descriptions of packages or code snippets commented into blocks.

For example, add a multi-line comment above the main() function to explain what the main() function does:

/*
main()函数是Go程序的入口函数
是程序运行的起点
此处输出"Hello World!"
用于验证开发环境配置
*/
func main(){
    //输出"Hello World!"文字
    fmt.Println("Hello World!")
}

Unlike single-line comments, multi-line comments are not allowed to be nested, because this will cause a compile-time error and prevent the compilation from being completed. The example is as follows:

/*
main()函数是Go程序的入口函数
/*是程序运行的起点
此处输出"Hello World!"
*/
用于验证开发环境配置
*/

To add a blank line, you can implement it in the following format:

/*
第1行

第3行
第4行
*/

Note:

Code is written for people to read. Developing good coding habits is not only beneficial to the coding itself, but also provides a lot of benefits to teammates in the development team. Good support. In actual development, the cost of communication between personnel may be huge to a "terrible" level, please keep this in mind.

[Related recommendations:

Go video tutorial, Programming Teaching】

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