Java帮助文档的生成

首先需要对代码加上文档的注释，比如下面这样：
package wz.learning;
/**
* Title:Person<br>
* Description:
* Company:SKJP
* @author xiashengwang
* @version 1.0
*/
public class PersonWZ {
/**
* 这是Person的构造函数
* @param name Person的名字—
*/
public PersonWZ(String name){
}
/**
* 这是读取方法
* @param bookName 书名
* @param time 读书的时间
* @return 返回读书的次数
*/
public int Read(String bookName, int time){
return 0;
}
}

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，就可以看到我们的注释了。

转载于:https://www.cnblogs.com/xiashengwang/p/5823192.html

Java帮助文档的生成相关推荐

Java api文档自动生成工具smartdoc+torna
首先,一般做java服务端都用过postman,并且都写过前端调用的api文档接口,并且也用过市面上的一些工具. API自文档动生成,能够省去了写文档的时间. 当然,当前也会有很多类似的开源工具,我们 ...
java注释文档如何生成_Eclipse中java生成注释文档
使用eclipse生成文档(javadoc)主要有三种方法: 1. 在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在 ...
用java写ods系统_基于数据库的代码自动生成工具，生成JavaBean、生成数据库文档、生成前后端代码等(TableGo v7.0.0版)...
TableGo是基于数据库的代码自动生成工具,低代码编程技术的实现,可以零代码自动生成SpringBoot项目工程.生成JavaBean.生成前后端分离的CRUD代码.生成MyBaits的Mapper ...
java生成iso9660工具_基于数据库的代码自动生成工具，生成JavaBean、生成数据库文档、生成前后端代码等(TableGo v7.0.0版)...
TableGo_20210212 v7.0.0 正式版发布,此次版本更新如下: 1.新增对DB2数据库的支持 2.新增按字段生成文件,支持把字段.JSON.XML数据转换成任何代码 3.新增大量新的自 ...
Java支持latex,基于Java和LaTeX的文档自动生成技术研究
基于Java和 LaTeX 的文档自动生成技术研究 ◆尚宝欣徐屹 (东北电力大学理学院,吉林长春 132012) [摘要]讨论了结合Java与LaTex 自动生成 PDF文档的方法.针展名 ...
Java实现生成数据库表结构文档（生成工具screw的使用）
目录一.screw介绍 1.简介 2.特点 3.文档格式二.生成方式 2.1 方式1:使用 Java 代码 2.1.1 引入依赖 2.1.2 编写代码 2.1.3 测试 2.2 方式2:使用 Sp ...
java 文档自动生成的神器 idoc
写文档作为一名开发者,每个人都要写代码. 工作中,几乎每一位开发者都要写文档. 因为工作是人和人的协作,产品要写需求文档,开发要写详细设计文档,接口文档. 可是,作为一个懒人,平时最讨厌的一件事情就 ...
Javadoc （Java API 文档生成器）详解 [Javadoc 概述][Javadoc 标签][Javadoc 命令][Javadoc 生成 API 文档]
您的"关注"和"点赞",是认可,是支持,是动力. 如意见相佐,可留言. 本人必将竭尽全力试图做到准确和全面,终其一生进行修改补充更新. 文章目录 1 Javad ...
【使用分享】一文掌握Aspose.Words for Java,实现Word文档的生成与操作
Aspose.Words for Java是一个功能强大的Java Word文档处理组件,支持文档的生成.修改.转换.渲染等功能.本文将为您全面介绍Aspose.Words的主要功能与用法. 一.文档 ...
Spring Boot 2.x基础教程：Swagger静态API文档的生成
点击蓝色"程序猿DD"关注我回复"资源"获取独家整理的学习资料! 作者 | 翟永超来源 | didispace.com/spring-boot-learni ...

Java帮助文档的生成

Java帮助文档的生成相关推荐

最新文章

热门文章