文档章节

Java生成javadoc

quickhelper
 quickhelper
发布于 2015/08/12 23:14
字数 358
阅读 1
收藏 0

一、Javadoc介绍


Javadoc其实平常我们都会见到,JAVASE的API文档就是一个javadoc,很明显,Javadoc的目的是为了能够让外部客户理解我们的代码并使用我们对外的接口。

记住:编写Javadoc的时候只需要对外的接口即可,不需要内部的接口也编写Javadoc注释;


二、Javadoc注释


一般我们的注释形式是:

(1) //

(2) /*     */

而Javadoc注释的形式是:

/** 

  1.  *  

  2.  * @return  

  3.  */  

注意:必须以/**开头;


三、Eclipse生成Javadoc文档


1.编写Javadoc注释

在Eclipse中,如果在某个方法前面输入/**后回车,则会自动生成Javadoc注释的格式,比如:

[public void setAge(int age) {  

  1.     this.age = age;  

  2. }  

在以上代码的上一行输入/** 后回车,则会生成如下形式的注释:

/** 

  1.  *  

  2.  * @param age  

  3.  */  

  4. public void setAge(int age) {  

  5.     this.age = age;  

  6. }  

2.生成Javadoc注释

如果想生成某个文件或工程的Javadoc文档,则右击后点击Export,然后选择javadoc,即可生成Javadoc;

(可能会出现编码问题,比如一个浏览器不会出现乱码,而一个浏览器会出现乱码,比如我生成的中文文档,safari是乱码,IE不是乱码);


四、示例


代码如下:

 * 创建Person对象的另一种方式 

  1.  * @param name 姓名 

  2.  * @param age 年龄 

  3.  * @return Person对象 

  4.  */  

  5. public static Person getInstance(String name,int age){  

  6.     return new Person(name,age);  

  7. }  

则生成的形式如下:


本文转载自:http://blog.csdn.net/xiazdong/article/details/7184012

quickhelper
粉丝 1
博文 82
码字总数 5482
作品 0
武汉
程序员
私信 提问
maven:java8下当javadoc有编译错误时无法生成.jar包的问题

之前一直在java 7下编译maven项目,遇到javadoc编译提示代码注释中有错误(比如连接无效),也能正常生成javadoc jar包。但最近将编译器换成java 8后,同样的命令执行,遇到javadoc编译错误,m...

xiaomin0322
07/10
22
0
eclipse中自动生成javadoc文档的方法

这篇文章主要介绍了eclipse中自动生成javadoc文档的方法,是实用eclipse开发Java程序时非常实用的技巧,对于进行Java项目开发具有一定的参考借鉴价值,需要的朋友可以参考下 本文实例讲述了ecl...

Carl_
2015/05/06
693
0
eclipse生成javadoc文档

编写Javadoc 代码 在Java 代码的类、函数、数据成员前中输入/** 回车,Eclipse 能够自动生成相应的Javadoc 代码。可以在后面添加相关的文字说明。 生成Javadoc 文档 方法有三: 选择工程,在...

xiahuawuyu
2012/10/13
133
0
maven-site-plugin 使用

maven-site-plugin是一个负责为Java项目生成静态HTML网站的插件。这个插件非常的有用,里面可以嵌入各种插件,比如用来对代码检查bug的findbugs,检查代码风格的checkstyle,生成testng测试报告...

长平狐
2012/08/28
4.6K
0
GroovyHelp 3.2.1 RC发布

GroovyHelp简介 GroovyHelp是一款Javadoc及Groovydoc搜索查阅软件,它能够帮助Java开发人员以及Groovy开发人员方便快速地查找API文档并对其进行高效管理,从此无需苦苦寻觅chm格式的帮助文档...

红薯
2011/11/28
135
0

没有更多内容

加载失败,请刷新页面

加载更多

Mybatis Plus删除

/** @author beth @data 2019-10-17 00:30 */ @RunWith(SpringRunner.class) @SpringBootTest public class DeleteTest { @Autowired private UserInfoMapper userInfoMapper; /** 根据id删除......

一个yuanbeth
今天
4
0
总结

一、设计模式 简单工厂:一个简单而且比较杂的工厂,可以创建任何对象给你 复杂工厂:先创建一种基础类型的工厂接口,然后各自集成实现这个接口,但是每个工厂都是这个基础类的扩展分类,spr...

BobwithB
今天
5
0
java内存模型

前言 Java作为一种面向对象的,跨平台语言,其对象、内存等一直是比较难的知识点。而且很多概念的名称看起来又那么相似,很多人会傻傻分不清楚。比如本文我们要讨论的JVM内存结构、Java内存模...

ls_cherish
今天
4
0
友元函数强制转换

友元函数强制转换 p522

天王盖地虎626
昨天
5
0
js中实现页面跳转(返回前一页、后一页)

本文转载于:专业的前端网站➸js中实现页面跳转(返回前一页、后一页) 一:JS 重载页面,本地刷新,返回上一页 复制代码代码如下: <a href="javascript:history.go(-1)">返回上一页</a> <a h...

前端老手
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部