一、注释(comment)

  1、注释作用

    注释用于注解说明解释程序的文字就是注释。

  2、注释好处

    (1)提高了代码的阅读性;调试程序的重要方法。

    (2)提高了代码的阅读性;调试程序的重要方法。

    (3)将自己的思想通过注释先整理出来,再用代码去体现

  3、注释的分类

    (1)单行注释

    (2)多行注释

    (3)文档注释(Java特有)

  4、单行注释

    格式:

//注释文字

  5、多行注释

    格式:

/*

注释文字

*/

    对于单行和多行注释,被注释的文字,不会被JVMjava虚拟机)解释执行

     多行注释里面不允许有多行注释嵌套。

  6、文档注释

    格式:

/**
  @author 指定java程序的作者
  @version 指定源文件的版本
*/ 

    注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。
       命令:

javadoc  -d mydoc  -author  -version  HelloWorld.java

javadoc -d -doc 源文件名称

    

 

     注意:文档注释只能注释类和函数,编译文档注释源文件 javadoc -d -doc 源文件名称

二、Java API 文档

  1、API Application Programming Interface,应用程序编程接口)是 Java 提供的基本编程接口

  2、Java语言提供了大量的基础类,因此 Oracle 也为这些基础类提供了相应的API文档,用于告诉开发者如何使用这些类,以及这些类里包含的方法。

    Java API 文档是 Java 程序开发补课缺少的编程词典,里面记录了 Java 语言中海量的 API,主要包括类的继承结构、成员变量和成员方法、构造方法,静态成员的详细说明和描述信息。

     API文档

  3、下载APIhttp://www.oracle.com/technetwork/java/javase/downloads/index.html

  将页面上的滚动条向下滚动,找到”Additional Resources”部分。如下:

  

 

  或者通过主页面,找到链接地址进来:
  

 

   

 

   

 

   Java8 API 文档

 

posted on 2020-08-11 21:29  格物致知_Tony  阅读(460)  评论(0编辑  收藏  举报