博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
javadoc工具生成自己的API文档
阅读量:6816 次
发布时间:2019-06-26

本文共 841 字,大约阅读时间需要 2 分钟。

hot3.png

javadoc默认只处理public和protected修饰的内容,如果要提取private,只需在用javadoc时加-private选项。

另外javadoc只处理文档注释即为/**..................*/和只有对处于多个包下面大源文件来生成API文档时,才有概览页面。

javadoc命令的基本用法如下:

javadoc 选项 java源文件/包 选项 -d 生成文件名 -windowtitle 浏览器窗口标题 -doctitle 概述页面标题 -header 页眉 文档注释常用如下:

@version

@param

@throws

不过这些标记大使用是用位置限制的

结合一个例子:

第一类JavadocTest.java

package bb;/** 主要入口点*/public class JavadocTest{	public static void main(String[] args)	{		System.out.println("hello!javadoc");	}}

第二个类:Test.java

package yee;/**  test  test  test*/public class Test{	/**	 age属性	*/	public int age;	//count	public int count;	public Test()	{	}}

命令执行:javaLearn$ javadoc -d apidoc -windowtitle 测试 -doctitle 学习javadoc工具测试api文档 -header 我的类 -encoding UTF-8 -charset UTF-8  *Test.java

如果项目是utf-8,为防止出现乱码,可以加入-encoding UTF-8 -charset UTF-8;

运行结果如下:

apidoc

转载于:https://my.oschina.net/u/566829/blog/61982

你可能感兴趣的文章
HTML5 全屏显示兼容方案
查看>>
Android View.setTranslationX实现可滑动的指示器
查看>>
Nginx 高并发负载均衡配置详解
查看>>
小技巧,Tomcat 下 Servlet3.0 应用无 web.xml 指定欢迎页引出的路径消除
查看>>
zui
查看>>
idea面板介绍
查看>>
angular之bootstrap()
查看>>
linux系统学习第十天-<<工程师技术>>
查看>>
系统架构设计指导原则(附整体架构图及框架/代码原则)
查看>>
electron 入门
查看>>
shell sudo 交互
查看>>
Mantis-如何导出自定义字段的值
查看>>
PHP中$_SERVER的详细参数与说明
查看>>
javascript event对象 与 jquery event 解析
查看>>
MySQL5.7使用Notifier启动、停止服务时出现的问题
查看>>
今天用java弄个json数据交换接口,个人感觉这样实现省事实力。
查看>>
color值
查看>>
mybatis 多表关联查询
查看>>
理解css、div、javascript(js),容器、内容与修饰,引发对未来网站的思考
查看>>
Darwin Streaming Server源码分析
查看>>