使用javadoc生成API网页文档

首先是一个简单的javadoc的用法的Demo:

1.创建普通java Project

项目源码的根路径是  E:\androidworkspace\javadoc\src

项目结构:

项目源码:

net.qingtian.doc.Teacher:

package net.qingtian.doc;
/**
 * 老师
 * <img src="doc-files/Button.gif">
 * @author 晴天
 * @see net.qingtian.doc.aa#Student 参考
 *
 */
public class Teacher {
	/**
	 * 性别
	 */
	public String sex;

	/**
	 * 显示性别
	 */
	public void showSex(){
	}
}

net.qingtian.doc.aa.Student:

package net.qingtian.doc.aa;

/**
 * 学生
 * @author 晴天
 */
public class Student {
	/**
	 * 姓名
	 */
	public String name;

	/**
	 * 显示姓名
	 */
	public void showName(){
	}
}

net.qingtian.doc.package.html:

<head>1234</head><body>abcd<a href="http://www.mabinbin.com">晴天</a></body>

2.生成api文档

a)在e盘下创建mydoc文件夹,存放生成的api文档。

b)在windows下打开黑窗口,然后进入到项目源码的根目录,以上面的项目为例,源码根目录为E:\androidworkspace\javadoc\src

C:\Users\Administrator>e:
E:\>cd E:\androidworkspace\javadoc\drc
E:\androidworkspace\javadoc\src>

c)在e盘下创建文件 e:\ file.txt (文件的名字可随意,只要后面使用的时候和这个对应就可以)。文件的内容为

net.qingtian.doc.aa
net.qingtian.doc

d)在黑窗口执行命令:javadoc -d e:\mydoc e:\file.txt

即E:\androidworkspace\javadoc\src>javadoc -d e:\mydoc e:\file.txt

e)文档已经生成,查看

使用javadoc常遇到的问题:

首先   javadoc命令的格式          javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]

1.options选项里   (-d  e:\mydoc    设置输出路径)   (-public/-protect/-private    设置哪些被生成文档)

2.使用javadoc时,可以使用以下参数   -sourcepath  E:\androidworkspace\javadoc\src   来设置需要生成api文档的源码的根路径,在我们刚才的操作中我们没有使用该选项,因为我们把黑窗口的当前路径设置为源码的根路径了,所以可以不使用该选项。

3. 使用javadoc时,可以设置-classpath classpathlist 这个参数,类似于-sourcepath sourcepathlist,只是他们一个是源码的路径,一个是二进制的文件的路径,不如有引用的外部的jar文件时设置,并不很常用。

4.javadoc可以为包和为文件生成api文档两种,对于为包生成文档时,不能递归的生成。如果包比较多,那么我们需要把包全部做为参数放在黑窗口命令的最后,这样当然是不方便的。所以有一个简单些的方式,也是刚才demo中用到的,就是把这些包名放在一个文件里,在命令的最后指定使用这个文件就可以 @filePath

5.中文乱码,javadoc默认是GBK编码,如果项目里用的是utf-8编码,那么在javadoc命令里添加选项
-encoding UTF-8 -charset UTF-8

6.参考http://www.360doc.com/content/06/0901/14/5874_196090.shtml

时间: 2024-10-12 00:19:56

使用javadoc生成API网页文档的相关文章

SpringBoot + Swagger2 自动生成API接口文档

spring-boot作为当前最为流行的Java web开发脚手架,相信越来越多的开发者会使用其来构建企业级的RESTFul API接口.这些接口不但会服务于传统的web端(b/s),也会服务于移动端.在实际开发过程中,这些接口还要提供给开发测试进行相关的白盒测试,那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题. 假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝,那么尝试一下Swagger2 方式,一定会让你有不一样的开发体验: 功能丰富 :支持多种注解,自动生成接

使用Eclipse生成CHM帮助文档(图解)

使用Eclipse生成CHM帮助文档(图解) 博客分类: System Operate javadoc生成chm文档java生成api帮助文档api帮助文档生成工具 Eclipse JavaDoc和jd2chm创建CHM文档 由于图片在这里贴在这里比较麻烦,所以图片见附件 一.首先创建一个java项目 二.导入需要生成API文档的项目源文件 三.复制到新建项目的src目录下 四.导入项目所依赖的相应jar包 要注意的是:处理view层的框架还需要用到 jsp.api.jar 和 servlet.

app后端开发二:API接口文档工具

悲伤的历史 在进行app后端开发过程中,后端会提供出来很多的api接口供前端开发使用,为了让前端开发人员顺利使用,我们会写好一份文档,告诉他们这个接口你该用 GET 还是 POST 来访问,同时访问的时候该给我传递一些什么参数,以及正确的时候我会返回什么给你,已经返回的数据样式以及字段解释等等这些事情,我们都需要在文档中写好写清楚. 在 app后端开发一:基于swagger-ui构建api接口文档工具 这篇博客中,我写了 swagger-ui 的好处以及优势.但是在使用过程中,发现不够给力.我想

asp.net web api 构建api帮助文档

1 概要 创建ASP.NET Web Api 时模板自带Help Pages框架. 2 问题 1)使用VS创建Web Api项目时,模板将Help Pages框架自动集成到其中,使得Web Api项目引入了MVC框架开发包,使得项目看起来杂乱. 2)自带的Help Pages框架无法针对Odata控制器生成API文档. 3 问题解决方案 1)独立Help Pages项目,以插件形式添加服务 步骤1,添加类ServiceAssembliesResolver,获得服务集 /// <summary>

Api接口文档管理工具,你知道哪些呢?

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以

API的文档自动生成——基于CDIF的SOA基本能力

当前,作为大部分移动app和云服务后台之间的标准连接方式,REST API已经得到了绝大部分开发者的认可和广泛的应用.近年来,在新兴API经济模式逐渐兴起,许多厂商纷纷将自己的后台业务能力作为REST API开放出来,给更广泛的第三方开发者使用. 但是,管理REST API并非是一件容易的工作.由于缺乏有效的接口数据schema约束,加上设计REST API时resource endpoint的安排,以及发送http请求的方式又都五花八门,REST API开发完成后,大多数情况下API开发者仍然

用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档

博客搬到了fresky.github.io - Dawei XU,请各位看官挪步.最新的一篇是:用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档.

【Firefly API 新版文档】Package dbentrust

原地址:http://blog.csdn.net/uxqclm/article/details/11969653 该包下面主要是数据库的处理与memcached存储.里面封装了,从memcached数据到python对象的映射.可以以操纵python对象的方式进行memcached中存储的数据的操作,只要在不同的进程中实例化相同名称的memobject对象,就能保证对象中的数据是一致的.还包含了将这个对象中的数据同步到数据库的出来方法.这里不需去写一句sql语句. class DBPool数据库

Swagger UI教程 API 文档神器 搭配Node使用 web api 接口文档 mvc接口文档

两种方案 一.Swagger 配置 web Api 接口文档美化 二.通过NodeJS 发布Swagger UI 配置api 文档 先说一下简单的 Swagger 配置 web Api  Swagger-UI本身只提供在线测试功能,要集成它还需要告诉它本项目提供的各种服务和参数信息.这里就需要一些工作量了,不过好在许多第三方库已经给我们完成了这一工作.我这里用的是Swashbuckle,使用它也比较简单,直接使用Nuget添加其程序包即可: 1.初始化包  PM> Install-Package