|名词定义|
在计算机语言中,注释是计算机语言的一个重要组成部分,用于在源代码中解释代码的功用,可以增强程序的可读性,可维护性,或者用于在源代码中处理不需运行的代码段,来调试程序的功能执行。
注释在随源代码进入预处理器或编译器处理后会被移除,不会在目标代码中保留其相关信息。
注释的作用:标识程序是干什么的,以及它是如何构建的。注释帮助程序员进行相互沟通以及理解程序。注释不是程序设计语言,所以编译器编译程序时忽略它们。
注释的本质在于,编译器在进行程序编译的时候如果发现有注释的内容将不对此部分进行编译处理,在Java语言里面对于注释一共有3类形式:
• 单行注释://;
• 多行注释:/.../;
• 文档注释:/*.../,文档注释里面还需要有很多的选项,一般建议通过开发工具控制。
|适用场景|
在注释中,可以插入各种资源和元数据。
• 常见的资源有:图标、流程图、著作权。
• 常见的元数据有:维护者、第一版的时间、编辑者、相关文档的链接等。
|参考资料|
[1] [ 阿里云大学]
[2] Java开发者