使用eclipse生成java doc文档 【转】
来源:互联网 发布:电驴连不上kad网络 编辑:程序博客网 时间:2024/05/16 06:45
一、Javadoc介绍
Javadoc其实平常我们都会见到,JAVASE的API文档就是一个javadoc,很明显,Javadoc的目的是为了能够让外部客户理解我们的代码并使用我们对外的接口。
记住:编写Javadoc的时候只需要对外的接口即可,不需要内部的接口也编写Javadoc注释;
二、Javadoc注释
一般我们的注释形式是:
(1) //
(2) /* */
而Javadoc注释的形式是:
- /**
- *
- * @return
- */
注意:必须以/**开头;
三、Eclipse生成Javadoc文档
1.编写Javadoc注释
在Eclipse中,如果在某个方法前面输入/**后回车,则会自动生成Javadoc注释的格式,比如:- public void setAge(int age) {
- this.age = age;
- }
- /**
- *
- * @param age
- */
- public void setAge(int age) {
- this.age = age;
- }
2.生成Javadoc注释
如果想生成某个文件或工程的Javadoc文档,则右击后点击Export,然后选择javadoc,即可生成Javadoc;
javadoc command:应该选择jdk的bin/javadoc.exe
(可能会出现编码问题,比如一个浏览器不会出现乱码,而一个浏览器会出现乱码,比如我生成的中文文档,safari是乱码,IE不是乱码);
四、示例
- /**
- * 创建Person对象的另一种方式
- * @param name 姓名
- * @param age 年龄
- * @return Person对象
- */
- public static Person getInstance(String name,int age){
- return new Person(name,age);
- }
则生成的形式如下:
以下是我实际操作时遇到的问题:
如果出现错误“错误: 编码GBK的不可映射字符”
在vm option里输入 “-encoding utf-8 -charset utf-8”
- 使用eclipse生成java doc文档 【转】
- eclipse 使用 java doc 生成文档的经验
- java生成doc文档
- eclipse生成java doc
- Myeclipse生成Java doc文档
- Myeclipse生成Java doc文档
- 使用Eclipse导出doc文档
- JAVA使用swagger api的doc文档生成
- MyEclipse/Eclipse 生成Java Doc
- MyEclipse/Eclipse 生成Java Doc
- eclipse自动生成项目doc文档
- Eclipse文档注释生成doc方法
- 使用GTK-DOC自动生成API文档
- Ant生成Java帮助文档doc
- JAVA通过模板生成DOC文档
- eclipse java doc export 文档乱码问题
- 【Java】使用Eclipse生成API文档
- Java--Eclipse中生成java doc
- Word中的EQ域输入公式详解
- C++之模板
- android 屏幕分辨率问题
- phonegap for ios 建立、打包、运行详细流程 黑喂狗
- RedHat Linux磁盘空间不足 和 挂载新硬盘方法
- 使用eclipse生成java doc文档 【转】
- JNA示例 调用dll
- Mule ESB
- 【Android布局】在程序中设置android:gravity 和 android:layout_Gravity属性
- C#操作注册表
- 使用JDBC调用存储过程
- c++ string 转化大小写
- jetty配置
- 开源 免费 java CMS - FreeCMS1.3 标签 channelPath