注释到底是什么
注释是计算机语言的重要组成部分。良好的注释是良好编程习惯的标志。
核心定义
- 注释是在源代码中用于提供代码功能说明的文本。
- 注释不会被编译器包含在最终的可执行程序中，因此不会影响程序的运行。
- 注释帮助程序员更容易理解代码的用途和功能，在团队协作中非常有用。
Java 的三种注释
- 单行注释：以
//开始，只管到这一行的末尾 - 多行注释：以
/*开始，以*/结束，可跨任意多行 - 文档注释：以
/**开始，以*/结束，可被 javadoc 工具提取生成 API 文档
一句话记忆
- 注释是写给人看的第二份代码——机器不需要它，但你的队友需要。