在计算机编程中,代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一,它们主要用于帮助程序员更容易理解代码。例如,
//声明并初始化两个变量
int a =1;
int b = 3;
//打印输出
System.out.println("This is output");
在这里,我们使用了以下注释:
声明并初始化两个变量
打印输出
Java中的注释类型
在Java中,有两种类型的注释:
单行注释
多行评论
单行注释
单行注释在同一行开始和结束。要编写单行注释,可以使用//符号。例如,
// "Hello, World!" 程序示例
class Main {
public static void main(String[] args) {
{
// 打印输出 "Hello, World!"
System.out.println("Hello, World!");
}
}
输出:
Hello, World!
在这里,我们使用了两个单行注释:
"Hello, World!" 程序示例
打印输出 "Hello World!"
Java编译器会忽略从//行尾到行尾的所有内容。因此,它也称为行尾注释(单行注释)。
多行注释
当我们想写多行注释时,可以使用多行注释。要写多行注释,我们可以使用/*....*/符号。例如,
/* 这是多行注释的示例。
* 该程序将打印“ Hello,World!” 到标准输出。
*/
class HelloWorld {
public static void main(String[] args) {
{
System.out.println("Hello, World!");
}
}
输出:
Hello, World!
在这里,我们使用了多行注释:
/* 这是多行注释的示例。
* 该程序将打印“ Hello,World!” 到标准输出。
*/
这种类型的注释也称为传统注释。在这种类型的注释中,Java编译器将忽略从/*到的所有内容*/。
注释条件:
1、基本注释(必须加)
类(接口)的注释
构造函数的注释
方法的注释
全局变量的注释
字段/属性的注释
备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。
2、特殊必加注释(必须加)
典型算法必须有注释。
在代码不明晰处必须有注释。
在代码修改处加上修改标识的注释。
在循环和逻辑分支组成的代码中加注释。
为他人提供的接口必须加详细注释。
备注:此类注释格式暂无举例。具体的注释格式自行定义,要求注释内容准确简洁。