给代码添加注释的作用是什么?
发布时间
阅读量:
阅读量
在编写程序的过程中,为了提高代码可读性,通常会将实现的功能与附加的说明相结合,从而在实现功能的同时添加一些注释.这些注释用于对程序中的某个功能或某一行代码进行详细说明,以便于开发者在后期查阅与使用相关代码时更加容易地理解其具体作用.
注释仅限于Java源代码环境中起作用。
当构建Java程序时
开发人员应避免编写任何超出范围的
非正式文档或脚本等类型的元数据
以确保这些元数据不会被包含到最终生成的类字节数组里
Java中的注释有三种类型,具体如下:
1.单行注释
在编程中,单行注释常被用来对程序中的一行代码进行说明。通过符号'//'来标识这些注释,在符号后的部分即为被注释的内容。
int c = 10; // 定义一个整型变量c
多行注释
/* 定义一个整形变量x
将5赋值给变量x */
int x;
x = 5;
3.文档注释
文档注释通常是为计算机程序中某些特定类及其相关方法所制作的详细说明与解释。开发人员通常会利用JDK提供的javadoc工具来提取并生成一份API帮助文档。这些注释通常以斜杠 '/' 开头,并以斜杠 '/' 结束。例如:
/** * Title:HelloWorld类
* @author srx
* @version
全部评论 (0)
还没有任何评论哟~
