Go的注释

注释

• 核心作用：注释旨在让维护程序的人阅读，解释代码逻辑（如 pass_fail reports whether a grade is passing or failing.），编译器会完全忽略注释内容。
• 文件结构回顾：结合前文的 package main 与 func main()，注释常用于说明包功能或程序入口，不影响 go build 或 go run 的编译执行。

单行注释（最常用）

• 语法：以 // 标记，从斜杠到行尾的所有内容均视为注释。
• 使用形式：
  1. 独立成行：置于代码上方，说明整体逻辑。
  2. 行尾注释：置于代码同行之后（如 var TotalCount int // Can only be a whole number.）。

// The total number of widgets in the system.
var TotalCount int // Can only be a whole number.Code language: PHP (php)

多行注释（块注释）

• 语法：以 /* 开头，以 */ 结尾，两者之间的所有内容（包括换行符）都是注释。
• 使用场景：不常作为常规说明，多用于跨多行的详细文档说明，或临时注释大段代码。

/*
Package widget includes all the functions used
for processing widgets.
*/Code language: JSON / JSON with Comments (json)

总结

Go 社区强烈倾向使用 // 而非 /* */。此外，若注释紧挨着导出的变量/函数（如 TotalCount），其注释内容可被 godoc 工具提取生成文档。结合前节代码，保持注释简洁与 go fmt 格式化是专业实践。