导航:首页 > 程序命令 > javados命令

javados命令

发布时间:2022-07-25 22:19:40

1. 如何使用javadoc命令生成api文档,文档注释

使用javadoc命令生成api文档:

  1. 创建java源文件包。java文件都是存放在一个package包中,这样方便对java文件进行操作和区分,首先在磁盘上创建文件夹一样的方式创建package包。

  2. 创建java源文件。在包下,创建与文件名相同的java源文件,输入一些文档注释,这些文档注释用于自动的api文件进行说明使用。

  3. 进入java源文件目录。通过cd等windows命令进入java源文件包所在的磁盘位置。

  4. 查看javadoc命令使用说明。如果是第一次使用javadoc命令,可以通过javadoc -help命令查看javadoc使用说明。

  5. 开始创建api文件。使用命令输入javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author javadoc/Hello.java 进行文档生成。-d:文件存储位置; -head:文件头部名称; -version:显示版本; -author:显示作者; javadoc/Hello.java 处理的文件包以及java源文件。

  6. 查看生成的api文件。创建成功之后,就会自动创建指定的文件夹下生成api文件。打开index.html就是api文件的入口。

2. 如何使用javadoc

假设源代码在 C:\src 目录下,其中 com.liigo 是主包,其下可能有数十个子包,数百(千)个Java文件。目录结构大约是这样的:

- C:\
| src\
| com\
| liigo\

| ***
怎么才能以最简捷的方式生成所有的API文档呢?

c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.liigo

这样就搞定了,最终生成的API文档位于 c:\src\doc 目录(该目录是由javadoc.exe自动生成的)。

上面的用法利用了“当前目录”和“相对路径”,当然也可以用绝对路径:

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo

最终生成的API文档位于 c:\doc 目录(该目录同样是由javadoc.exe自动生成的)。

总结一下:

我们只用到了javadoc的三个参数: -d,-subpackages,-sourcepath,其中:

参数 说明
-d 指定API文档的输出目录,默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径,默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数!如果不使用本参数,每次只能处理一个子包(或需手工列出所有子包)。

注:以上示例要求 javadoc.exe 所在路径位于系统环境变量“PATH”中。

补充一点:

使用参数 -author 可以将作者信息(@author ***)导出到最终生成的API文档中, -version 可以生成版本信息。如果是自己写的一个包,千万不要忘了用 -author 哦:)

最终完整的命令行是:

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version

3. Java Javadoc命令

javadoc 命令是用来生成文档的。确保你的hello.java 文件里面有些注释。否则就是空的。或者你打开其他的html文件看看

4. 常见java的命令有些什么

javac:将源代码编译为class文件
java:执行class文件
javadoc:生成帮助文档及API
jar:将代码归档,生成一个jar包
备注:后缀为.exe的文件是一个应用程序的执行文件(客户端),
相当于java代码里面的主方法(main方法),
执行每一个java命令,相对于执行对应的源代码的主方法
2.1.2 lib:存放Java类库文件;一些jar包 工具类
2.1.3 jre: 客户端目录,供客户使用
2.1.4 demo:存放演示文件,可能没有这个目录

5. 哪种注释方法能够支持javadoc命令

文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javadoc直接生成相关文档,文档注释的基本格式为“/**...*/”,不仅仅如此,文档注释本身还存在语法:

1. 文档和文档注释的格式化:

生成的文档是HTML格式的,而这些HTML格式的标识符并不是javadoc加的,而是我们在写注释的时候写上去的。因此在格式化文档的时候需要适当地加入HTML标签,比如,需要换行时,不是敲入一个回车符,而是写入,如果要分段,就应该在段前写入。

2. 文档注释的三部分根据在文档中显示的效果,文档注释分为三部分:

第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。

第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。

阅读全文

与javados命令相关的资料

热点内容
北票女程序员 浏览:461
战地2枪械解压 浏览:41
pdf复选框 浏览:343
linux用户监控 浏览:35
化妆教程编译 浏览:131
python分组键的形式 浏览:721
佛教造像pdf 浏览:662
医疗不良事件上报系统源码 浏览:754
手机云视频加密怎么关 浏览:74
北京文件夹加密多少钱 浏览:671
什么是车鉴定app 浏览:66
战地一私人服务器怎么买 浏览:497
陈天程序员 浏览:833
编译原理如何运用到编程中 浏览:18
linux选择数据库 浏览:376
php两个数组差集 浏览:979
迷你pdf阅读器下载 浏览:433
做一个python小程序 浏览:655
pythonossystem和 浏览:645
win2008如何搭建ftp服务器 浏览:53