Java文档注释是一种功能强大的注释形式，如果在你所编写的程序中规范的添加文档注释，那你就可以生成一份系统正规的API文档。Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/。
Eclipse怎么生成API帮助文档呢，
方法有三：
方法一：选择工程，在菜单Project->Genarate Javadoc
方法二：选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮
方法三：选择工程，在菜单File->Export ，选择Java 下面的Javadoc ，点”next” 按钮
操作都一样我们以方法一为例：
Eclipse生成API帮助文档(图文详解)
在Eclipse新建一个项目test，包结构如下：
我为项目中的这三个类TestJavaDoc ，JavaBoc， TestJavadoc2添加了文档注释，类的源码如下：
01
|
package com.qiice.jboring;
|
04
|
*Copyrigth(C),2012,奇冰网qiice.com
|
10
|
public classTestJavaDoc {
|
22
|
publicTestJavaDoc(int age){
|
28
|
publicstatic void main(String[] args){
|
29
|
System.out.println("Hello qiice.com");
|
|
01
|
package com.qiice.test;
|
04
|
*Copyrigth(C),2012,奇冰网qiice.com
|
22
|
publicJavaDoc(int age){
|
28
|
publicstatic void main(String[] args){
|
29
|
System.out.println("Hello qiice.com");
|
|
01
|
package com.qiice.test;
|
04
|
*Copyrigth(C),2012,奇冰网qiice.com
|
10
|
public classTestJavadoc2 {
|
16
|
publicString age(int age){
|
|
我们使用的Ecplise来生成这个项目test的API文档
选中要生成API项目test 然后Project->Genarate Javadoc 如下图：
点击进入
这里要说一下API文档是给别人查看使用的，一些不想暴露的地方就不必显示，
Create Javadoc for members with visibility: 就是让你选择范围 private ，package ，protect ，public 。一般Javadoc 工具默认处理protect 或者public修饰的类，方法，属性等前面的注释。
Use standard doclet 选择生成的路径，我选择在桌面api文件夹内。
点击Next，进入如下图：
Document title是设置概述页面的标题
点击Finish就开始生成API了，点击生成的index.html页面就能看到生成的API了
我生成的API：点击打开生成的API。
常用的javadoc标记如下：
@author：指定java程序作者。可以出现在类或者接口文档注释中。
@version:程序版本。可以出现在类或者接口文档注释中。
@deprecated:不推荐使用的方法。可以出现在类，接口，方法，构造器，属性注释文档中。
@return:方法返回值的说明。可以出现在方法，构造器注释。
@see:指定参考内容。可以出现在类，接口，方法，构造器，属性注释文档中。
@exception:抛出异常类型。可以出现在方法，构造器注释文档中。
@throws:和exception同义，抛出异常.可以出现在方法，构造器注释文档中。
给你写的Java程序加上注释文档是不是感觉写的程序更酷了，你可以平时添加适当的文档注释，来熟悉熟练使用标记。关于javadoc感兴趣可以深入研究一下，还是有很多东西的。
版权所有奇冰网：转载请注明出处
本文链接：http://www.qiice.com/shujuleixing/JavaAPI2.html
关键字：注释|
- C语言的注释形式及作用,C语言注释详解（两种注释方式）
在编写C语言源代码时,应该多使用注释,这样有助于对代码的理解.在C语言中有两种注释方式: 一种是以/*开始.以*/结束的块注释(block comment): 另一种是以//开始.以换行符结束的单行注 ...
- java reference详解_你不可不知的Java引用类型之——Reference源码解析
定义 Reference是所有引用类型的父类,定义了引用的公共行为和操作. reference指代引用对象本身,referent指代reference引用的对象,下文介绍会以reference,ref ...
- Java基础——Java IO详解
一.概述 1.Java IO Java IO即Java 输入输出系统.不管我们编写何种应用,都难免和各种输入输出相关的媒介打交道,其实和媒介进行IO的过程是十分复杂的,这要考虑的因素特别多,比如我们要 ...
- Java虚拟机详解----JVM常见问题总结
[正文] 声明:本文只是做一个总结,有关jvm的详细知识可以参考本人之前的系列文章,尤其是那篇:Java虚拟机详解04----GC算法和种类.那篇文章和本文是面试时的重点. 面试必问关键词:JVM垃圾 ...
- Java多线程详解（线程不安全案例）
嗨喽-小伙伴们我又来了, 通过前面两章的学习,我们了解了线程的基本概念和创建线程的四种方式. 附上链接: 1. Java多线程详解(基本概念) 2. Java多线程详解(如何创建线程) ...
- Java程序中Doc（文档）注释详解
许多人写代码时总不喜欢写注释,每个程序员如此,嘿嘿,我也一样 不过,话说回来,该写还是要写哦!没人会喜欢一个不写注释的程序员,当然,也没有一个喜欢写注释的程序员,今天,我们就来说说Java注释之一-- ...
- Java代码中的注释详解
2019独角兽企业重金招聘Python工程师标准>>> java注释详解 声明:本文系JavaEye网站发布的原创博客文章,未经作者书面许可,严禁任何网站转载本文,否则必将追究法律责 ...
- packageinfo.java_package-info.java文件详解
package-info.java文件详解 一.pacakge-info.java介绍 pacakge-info.java是一个Java文件,可以添加到任何的Java源码包中.pacakge-info ...
- java 泛型详解-绝对是对泛型方法讲解最详细的，没有之一，大厂 HR 如何面试
写在最前面,我总结出了很多互联网公司的面试题及答案,并整理成了文档,以及各种学习的进阶学习资料,免费分享给大家.扫码加微信好友进[程序员面试学习交流群],免费领取.也欢迎各位一起在群里探讨技术. 对j ...
- java pattern详解_JAVA正则表达式：Pattern类与Matcher类详解
以下我们就分别来看看这两个类: 一.捕获组的概念 捕获组可以通过从左到右计算其开括号来编号,编号是从1 开始的.例如,在表达式 ((A)(B(C)))中,存在四个这样的组: 1 ((A) ...
