Java帮助文档的生成

  1. 首先需要对代码加上文档的注释,比如下面这样:
  2. package?wz.learning;??
  3. ??
    ?
  4. /**?
  5. ?*?Title:Person<br>?
  6. ?*?Description:?
  7. ?*?Company:SKJP?
  8. ?*[email protected]?xiashengwang?
  9. ?*[email protected]?1.0?
  10. ?*/??
  11. public?class?PersonWZ?{??
  12. ????/**?
  13. ?????*?这是Person的构造函数?
  14. ?????*[email protected]?name?Person的名字—?
  15. ?????*/??
  16. ????public?PersonWZ(String?name){??
  17. ??????????
    ?
  18. ????}??
  19. ??????
    ?
  20. ????/**?
  21. ?????*?这是读取方法?
  22. ?????*[email protected]?bookName?书名?
  23. ?????*[email protected]?time?读书的时间?
  24. ?????*[email protected]?返回读书的次数?
  25. ?????*/??
  26. ????public?int?Read(String?bookName,?int?time){??
  27. ????????return?0;??
  28. ????}??
  29. }??

    2,通过eclipse生成最简单,在项目在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。

    在Javadoc Generation对话框中有两个地方要注意的:
    javadoc command:应该选择jdk的bin/javadoc.exe
    destination:为生成文档的保存路径,可自由选择。
    按finish(完成)提交即可开始生成文档。

    注意,生成的文档可能出现乱码,可以这样解决:

    在Eclipse里 export 选 JavaDoc,在向导的最后一页的Extra JavaDoc Options 里填上参数即可
    比如项目采用的是UTF-8的编码就填:-encoding UTF-8 -charset UTF-8

    生成之后的文档结构如下:

    点开其中的index,就可以看到我们的注释了。

时间: 2024-10-05 15:26:42

Java帮助文档的生成的相关文章

MyEclipse生成java API文档

API文档是提供接口是必须的,如果用word文档,不仅书写起来很麻烦,而且对于使用者来说很不方便.可以使用myEclipse来生成API文档,与java提供的官方API文档一样.一下是详细步骤. /**  * 数据库操作通用程序包  */ package xju.dbhelper; import java.sql.*; /**  * 数据库操作通用接口  * @author xju  * @version 1.0  */ public abstract interface DBHelper {

删除vi编辑异常生成.test.java.swp文档的方法

删除vi编辑异常生成.test.java.swp文档的方法 在linux下用vi或vim打开Test.java文件时 [[email protected] tmp]# vi Test.java 出现了如下信息: E325: ATTENTION Found a swap file by the name ".Test.java.swp" owned by: root   dated: Wed Dec  713:52:562011 file name: /var/tmp/Test.java

优于 swagger 的 java markdown 文档生成框架-01-入门使用

设计初衷 节约时间 Java 文档一直是一个大问题. 很多项目不写文档,即使写文档,对于开发人员来说也是非常痛苦的. 不写文档的缺点自不用多少,手动写文档的缺点也显而易见: 非常浪费时间,而且会出错. 无法保证及时更新.代码已经变了,但是文档还要同步修改.需要强制人来维护这一种一致性.这很难. 为什么不是 swagger-ui java 的文档有几类: jdk 自带的 doc 生成.这个以前实践给别人用过,别人用 C#,看到 java 的默认文档感觉很痛苦. 就算是我们 java 开发者,也很讨

Java的字体类详解(Font)-摘自Java API文档

字体是个非常平常的概念,以至于看到Java API文档对于字体的长篇大论的说明时,我突然感觉自己很无知. 以下是英文原文: java.awt.Font The Font class represents fonts, which are used to render text in a visible way. A font provides the information needed to map sequences of characters to sequences of glyphs

[Java] Java API文档下载方法

Java API文档下载方法:http://jingyan.baidu.com/article/a3aad71ac9e48fb1fb009692.html Oracle : http://www.oracle.com/index.html

JAVA帮助文档全系列 JDK1.5 JDK1.6 JDK1.7 官方中英完整版下载

JAVA帮助文档全系列 JDK1.5 JDK1.6 JDK1.7 官方中英完整版下载JDK(Java Development Kit,Java开发包,Java开发工具)是一个写Java的applet和应用程序的程序开发环境.它由一个处于操作系统层之上的运行环境还有开发者编译,调试和运行用Java语言写的applet和应用程序所需的工具组成. JDK(Java Development Kit)是Sun Microsystems针对Java开发员的产品.自从Java推出以来,JDK已经成为使用最广泛

如何从sun公司官网下载java API文档(转载)

相信很多同人和我一样,想去官网下载一份纯英文的java API文档,可使sun公司的网站让我实在很头疼,很乱,全是英文!所以就在网上下载了别人提供的下载!可是还是不甘心!其实多去看看这些英文的技术网站很有好处!去官网下载的东西感觉也很好! 所以: 1.进入官网http://www.oracle.com/technetwork/java/index.html 2.Oracle主页 -> download下拉菜单里找到Java for development -> 按ctrl+F搜索Java SE

C# 在Word文档中生成条

简介 条形码是由多个不同的空白和黑条按照一定的顺序组成,用于表示各种信息如产品名称.制造商.类别.价格等.目前,条形码在我们的日常生活中有着很广泛的应用,不管是在图书还是各种商品上都随处可见,扫描条形码就可以查询这个商品的信息,非常方便. 生成 生成条形码分为两步,第一步需要先下载并在系统上安装条形码字体,安装条形码字体的步骤如下: 1.条形码的字体有很多种,如code39,code128等,网上有很多条形码字体,根据自己的需要选择条形码字体下载,然后在开始->运行里输入C:\Windows\F

java帮助文档下载

JAVA帮助文档全系列 JDK1.5 JDK1.6 JDK1.7 官方中英完整版下载JDK(Java Development Kit,Java开发包,Java开发工具)是一个写Java的applet和应用程序的程序开发环境.它由一个处于操作系统层之上的运行环境还有开发者编译,调试和运行用Java语言写的applet和应用程序所需的工具组成. JDK(Java Development Kit)是Sun Microsystems针对Java开发员的产品.自从Java推出以来,JDK已经成为使用最广泛