Java基础(02) Java注释以及Java API文档

Java基础(二) – Java注释以及Java API文档

​

Java规范的三种注释方式

1. 单行注释与多行注释
    作用：
    ① 对所写程序进行解释说明
    ② 注释掉调试代码
    
    特点：单行注释以及多行注释注释掉的内容不参与编译，换而言之，编译后生成的.class字节码文件中不存在注释掉的信息
    
    格式：单行注释 // 注释内容
    
         多行注释 
    	/*
         注释多行内容
         	...
            ...
            	*/
   
2. 文档注释 
    注释内容可以被JDK提供的工具 javadoc 解析，生成网页文件形式的程序说明
    
    格式：
    /**
    @author 作者
    @version 版本号
    具体信息
    */
    
    Javadoc 用法格式如下：
        javadoc [options] [packagenames] [sourcefiles]

        对格式的说明：
            options 表示 Javadoc 命令的选项；
            packagenames 表示包名；
            sourcefiles 表示源文件名。、
    
    在cmd下输入javadoc -help即可看到javadoc的具体使用方法

Java API文档

​ API(Application Programming Interface)，就是应用程序编程接口，用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。API文档就是对所有 API 的调用和其中涉及到的参数的清晰的解释说明。