Java注释–单行注释、多行注释、文档注释
单行注释和多行注释
语法格式
//单行注释
//单行注释
//注释内容
/*
这里可以放置多行注释
多行注释的内容
Java真的学起来有意思!!
*/
举例:
//这是一段用于测试注释的代码
public class Annotation_test{
public static void main(String[] args){
//下面的语句将原封不动输出:Hello Annotation!!
System.out.println("Hello Annotation!!");
}
}
编译和执行:
可见,注释不改变代码的输出
总结来说,注释有以下这些作用:
(1)增强可读性,注释起到解释说明的作用,不论是自己还是别人,看了注释,都会更明确代码的逻辑
(2)便于调试。发现有问题的代码,可以直接注释掉,便于排除代码中的障碍
其实我本人最讨厌什么注释都不写的代码,写注释真的是一个非常良好的习惯!
文档注释
举例:
/**
@author bones
@version 1.0
这是关于java基础的文档注释的 代码,非常好理解
*/
public class Anno_test2{
public static void main(String[] agrs){
System.out.println("Hello 文档注释!!");
}
/**
@param name 姓名
@param age 年龄
@param height 身高
*/
public boolean isPickSno(String name,int age,double height){
if(age>0){
return true;
}else{
return false;
}
}
}
文档注释的语法格式:
/**
文档注释的内容。。。。
*/
文档注释放在整个文件前面,可以说明作者、版本、日期、包名等信息,文档注释放在一个方法前面,可以说明形式参数等含义等。
同时文档注释可以配合javadoc.exe生成一套类似于关于这个自定义类的网页API
例如:
查看需要点击index.html文件:
跟Java的API很类似: