Java语言API编写指南.pdf

目录 Java 语言 api 编写指南.........................................................................................................................2 一、书写 javaDoc 注释.................................................................................................................3 二、生成 api 文档..........................................................................................................................8 1.采用命令行窗口...................................................................................................................8 2.采用 eclipse 生成...............................................................................................................9 3.采用 maven 命令生成.....................................................................................................11 三、在 Eclipse 或者 MyEclipse 中利用 xml 文件，自动生成注释....................................12 四、总结.........................................................................................................................................16 第 1 页 共 16 页 Java 语言 api 编写指南 Javadoc 是 Sun 公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形 成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的书写注释 的形式对代码作注释，在程序编写完成后，通过 Javadoc 就可以同时形成程序的开发文 档 api 了。 开发者在二次开发中 ,通过查阅你写的 api,就会对程序中某些自定义的方法或者整个代 码的层次结构都会有很好的了解 ,对代码的清晰阅读起到很重要的作用 ，而且有时候自己遗忘 了某些方法,也可以查阅此 api 文档从而使自己更加清晰各种变量或者方法的意义。 对于以后的开发工作来说 ,规范 api 书写，将是一个很好的编程习惯。 现在很多 IDE 都可以直接生成 javadoc，本篇主要介绍如何编写 javadoc 注释以及如何 在 eclipse 下生成 javadoc。 52:8087/jenkins/job/com.riambsoft.report/javadoc/ 第 2 页 共 16 页 一、书写 javaDoc 注释 我们知道 Java 中有三种注释语句： 1.//用于单行注释。 2./*...*/用于多行注释，从/*开始，到*/结束，不能嵌套。 3./**...*/则是为支持 jdk 工具 javadoc.exe 而特有的注释语句。 /** * Copy Right Information : RiambSoft * Project