第3章 Javadoc指令使用详细介绍
本章要点: Javadoc指令使用详细介绍 关于标识符和关键字 Javadoc指令使用详细介绍 java里面的注释分单行注释、多行注释和文档注释。这里重点讨论javadoc 指令的实际使用。 1.单行注释: 使用双斜线"//"放在需要注释的内容之前 2.多行注释:使用"/ “注释开始,” /"注释结束。 3.文档注释:文档注释以"/**"开始, 以"*/" 结束。 下面使用三个简单的案例介绍如何使用javadoc工具生成API文档。 案例1:javadoc命令生成简单的API文档: 1)来到JavadocTest.java和Test.java所在的路径 文件内容如下: 2)执行以下命令 $ javadoc -encoding GBK -d apidoc -windowtitle 测试 -doctitle 使用javadoc工具生成API文档 -header 我的类 *Test.java 参数解释: -encoding : javadoc执行时的编码指令,因为JavadocTest.java和Test.java中含有中文,所以要设置成GBK编码,否则会包“utf-8 不可编码”的错误 -d: 设置生成的API文档的路径,这里写“apidoc”会在当前路径处生成一个apidoc文件夹 -windowtitle:为api文档的浏览器窗口设置字符串标题。 -doctitle