java语言提供文档注释,通过javadoc工具可以将源代码中的文档注释提取成系统API文档。

javadoc工具只处理在类、接口、方法、Field、构造器和内部类之前的注释,而忽略其他注释。默认只处理public或protected修饰。

语法格式

javadoc [option] 源文件

javadoc命令的选项

  • -d :存放API文档的目录

  • -windowtitle :设置API文档的浏览器窗口标题

  • -doctitle :指定概述页面标题

  • -header :指定HTML格式的文本,包含每个页面的页面

常用的javadoc标记为:

  • @author

  • @version

  • @param

  • @return

  • @see

  • @exception

  • @throws

/**
* Description:
* <br/>注释
* @author kevin
* @version 1.0
*/
public class Hello{
    /**
    * hello
    * @param name 对方
    * @return 返回hello的字符串
    */
    public String hello(String name){
       return name+",你好!"; 
  }  
}

提取文档中的@author和@version等标记

javadoc -d apidoc -windowtitle 测试 -doctitle javadoc测试 -header hello -version -author Hello.java

数据类型

Java是强类型语言,在编译时就确定数据类型。Java支持的类型分为两类:

  • 基本类型:Primitive Type,包括boolean、数值类型

  • 引用类型:Reference Type,包括类、接口和数组、null

Java的布尔类型只能是true或false。

results matching ""

    No results matching ""