当前位置:首页>Java>Java教程>Java注释

Java注释

作者:微学网发布时间:2019-08-31 21:57:35

什么是Java注释

Java代码的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序,所以我们需要进行一些注释,可以是编程思路或者是程序的作用,总而言之就是方便自己他人更好的阅读。

注释的作用

通过注释提高程序的可读性,是java程序的条理更加清晰,易于区分代码行与注释行。
另外通常在程序开头加入作者,时间,版本,要实现的功能等内容注释,方便后来的维护以及程序员的交流。

注释的种类

对于Java注释我们主要了解三种:

  • // 注释一行

  • / …… / 注释若干行

  • /*……/文档注释

单行注释(line comment)

//表示,编译器看到//会忽略该行//后的所文本

多行注释(block comment)

/**/表示,编译器看到/*时会搜索接下来的*/,忽略掉/**/之间的文本。

文档注释

/** */表示,是Java特有的注释,其中注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。

示例

public static void main(String[] args) {
    // 第一步: 获取半径?并将半径保存在程序中
    double radius = 5;

    // 第二步:计算面积,并将面积保存在程序中
    /*
    double area = radius * radius * 3.1415;    
    // 第三步:在控制台现实面积
    System.out.println("半径为" + radius + "的圆的面积为:" + area);
    */
}

注意事项

多行注释中可以嵌套单行注释,多行注释不能嵌套多行注释。

class Demo{
    /*
        这是主函数,是程序的入口
        它的出现可以保证程序的独立运行
    /*
        注意:多行注释嵌套多行注释是不行的。
    */
    */
    public static void main(String[] args){
        //这是输出语句用于将括号内的数据打印到控制台。
        System.out.println("hello java");
    }

文档注释

编写软件说明书

  • 需要使用sun公司给我们提供的javadoc工具生成一个html的说明文档。

  • javadoc只能在publicprotected修饰的方法或者属性之上

格式

Javadoc –d 指定存储文档的路径  -version –author(可选)  目标文件

示例

JavaDoc示例

示例解释

@author 作者
@version 版本
@param 方法的参数
@return 返回值

注释的使用细节

三种注释可以出现在程序的任何地方,但是不推荐找任意位置。

编程习惯

  • 给那条语句进行说明,注释应该写在该语句的旁边。

  • 单行注释一般写在语句的后面多行注释和文档注释一般写在语句的上面

  • 注意:文档注释只能出现在类、属性、方法的上面。

多行注释

注释的嵌套

  • 单行注释可以在单行注释里面。

  • 多行注释不能嵌套在多行注释里面。

注释的嵌套

注释的调试作用

  • 可以作为初学者的调试方式。

  • 可以帮组初学者确定代码的错误之处。

注释的调试作用