Java语言API编写指南.pdfVIP

目录 Java 语言 api 编写指南2 一、书写 javaDoc 注释3 二、生成 api 文档8 1.采用命令行窗口8 2.采用 eclipse 生成9 3.采用 maven 命令生成11 三、在 Eclipse 或者 MyEclipse 中利用 xml 文件，自动生成注释12 四、总结16 第 1 页 共 16 页 Java 语言 api 编写指南 Java 语言 api 编写指南 JJaavvaa语语言言aappii编编写写指指南南 Javadoc 是 Sun 公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形 成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的书写注释 的形式对代码作注释，在程序编写完成后，通过 Javadoc 就可以同时形成程序的开发文档 api 了。 开发者在二次开发中,通过查阅你写的 api,就会对程序中某些自定义的方法或者整个代 码的层次结构都会有很好的了解,对代码的清晰阅读起到很重要的作用，而且有时候自己遗忘 了某些方法,也可以查阅此 api文档从而使自己更加清晰各种变量或者方法的意义。 对于以后的开发工作来说,规范 api 书写，将是一个很好的编程习惯。 现在很多 IDE 都可以直接生成 javadoc，本篇主要介绍如何编写 javadoc 注释以及如何 在 eclipse 下生成 javadoc。 52:8087/jenkins/job/com.riambsoft.report/javadoc/ 第 2 页 共 16 页 一、书写 javaDoc 注释 一、书写 javaDoc 注释 一一、、书书写写 jjaavvaaDDoocc注注释释 我们知道 Java 中有三种注释语句： 1.//用于单行注释。 2./*...*/用于多行注释，从/*开始，到*/结束，不能嵌套。 3./**...*/则是为支持 jdk 工具 javadoc.exe 而特有的注释语句。 /** *CopyRightInformation :RiambSoft *Project :report *JDKversionused :jdk1.5 *Comments :configpath *Version :1.01 *Modificationhistory :2013.1.28 *SrDate ModifiedBy Why Whatismodified *1. 2013.1.28刘振宇 reportforPdf/Excel/Csv */ javadoc 工具能从 java 源文件中读取/**...*/注释，并能识别注释中用@标识的一些特殊变 量，制作成 Html 格式的类说明文档，生成 api 文档。 关键词列表 @author 作者名 @version 版本标识 @param 参数及其意义 @since 最早使用该方法/类/接口的 JDK 版本 @return 返回值 @throws 异常类及抛出条件 @deprecated 引起不推荐使用的警告 @see 参考类、方法、变量 第 3 页 共 16 页 @override 重写 对于一个 java 类文件,我们需要四大块 java doc 注释，便可生成 api 文档 1.文件注释 2.类注释 3.属性注释 4.方法注释 这个规范的话也很简单，如果用 ide 进行开发，我们有做好的 xml 格式的注释模板，直接放 到 eclipse 里面就能用了，稍后会有说明。 例子说明 ExcelDocument . java 文件 /