导航:首页 > 编程语言 > java注释生成doc

java注释生成doc

发布时间:2024-04-06 14:11:35

java中如何自动生成注释

你说的应该是生成javadoc吧?

最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:

javadoc-ddocs-subpackagescom.yourpackage

其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代码包.


JAVADOC是官方提供的一种生成注释文档的工具, 他的用法如下:

用法:javadoc[options][packagenames][sourcefiles][@files]
-overview<file>从HTML文件读取概览文档
-public仅显示public类和成员
-protected显示protected/public类和成员(默认值)
-package显示package/protected/public类和成员
-private显示所有类和成员
-help显示命令行选项并退出
-doclet<class>通过替代doclet生成输出
-docletpath<path>指定查找doclet类文件的位置
-sourcepath<pathlist>指定查找源文件的位置
-classpath<pathlist>指定查找用户类文件的位置
-cp<pathlist>指定查找用户类文件的位置
-exclude<pkglist>指定要排除的程序包列表
-subpackages<subpkglist>指定要递归加载的子程序包
-breakiterator计算带有BreakIterator的第一个语句
-bootclasspath<pathlist>覆盖由引导类加载器所加载的
类文件的位置
-source<release>提供与指定发行版的源兼容性
-extdirs<dirlist>覆盖所安装扩展的位置
-verbose输出有关Javadoc正在执行的操作的信息
-locale<name>要使用的区域设置,例如en_US或en_US_WIN
-encoding<name>源文件编码名称
-quiet不显示状态消息
-J<flag>直接将<flag>传递到运行时系统
-X输出非标准选项的提要

通过标准doclet提供:
-d<directory>输出文件的目标目录
-use创建类和程序包用法页面
-version包含@version段
-author包含@author段
-docfilessubdirs递归复制文档文件子目录
-splitindex将索引分为每个字母对应一个文件
-windowtitle<text>文档的浏览器窗口标题
-doctitle<html-code>包含概览页面的标题
-header<html-code>包含每个页面的页眉文本
-footer<html-code>包含每个页面的页脚文本
-top<html-code>包含每个页面的顶部文本
-bottom<html-code>包含每个页面的底部文本
-link<url>创建指向位于<url>的javadoc输出的链接
-linkoffline<url><url2>利用位于<url2>的程序包列表链接至位于<url>的文档
-excludedocfilessubdir<name1>:..排除具有给定名称的所有文档文件子目录。
-group<name><p1>:<p2>..在概览页面中,将指定的程序包分组
-nocomment不生成说明和标记,只生成声明。
-nodeprecated不包含@deprecated信息
-noqualifier<name1>:<name2>:...输出中不包括指定限定符的列表。
-nosince不包含@since信息
-notimestamp不包含隐藏时间戳
-nodeprecatedlist不生成已过时的列表
-notree不生成类分层结构
-noindex不生成索引
-nohelp不生成帮助链接
-nonavbar不生成导航栏
-serialwarn生成有关@serial标记的警告
-tag<name>:<locations>:<header>指定单个参数定制标记
-taglet要注册的Taglet的全限定名称
-tagletpathTaglet的路径
-charset<charset>用于跨平台查看生成的文档的字符集。
-helpfile<file>包含帮助链接所链接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每个制表符占据的空格数
-keywords使程序包,类和成员信息附带HTML元标记
-stylesheetfile<path>用于更改生成文档的样式的文件
-docencoding<name>指定输出的字符编码

Ⅱ java编程题目!提取java源代码中的注释生成javadoc或txt文件

用javadoc命令

格式如下
javadoc [options] [packagenames] [sourcefile] [@files]

ptions
命令行选项,如本文档中所指定。要了解 javadoc 选项的典型用法,参见实际示例。

packagenames
一系列包的名字,用空格分隔,例如 java.lang java.lang.reflect java.awt。必须分别指定想要为之建立文档的每一个包。Javadoc 不递归地作用于子包。不允许使用通配符,如(*)。参见示例 - 建立包的文档

sourcefiles
一系列源文件名,用空格分隔。源文件名可包括路径和通配符如(*)。例如:Button.java /home/src/java/awt/Graphics*.java 参见示例 - 建立类的文件。还可混合包名和源文件,如 示例 - 建立包和类的文档 中所示。

@files
以任何次序包含包名和源文件的一个或多个文件。

这样就可以生成程序文档资料了
不知道你要的是不是这个?

Ⅲ Java中的 /**......*/ 什么作用,怎么用

这是注释,你在写代码的时候,你如果使用这种注释,你使用javadoc命令,就会把注释回的内容生成文答档了,知道java的doc帮助文档吗?就是这么生成的
我给你举个例子
你去写这么一个类,记住,要这个类是public
/**
这是是javadoc,这是一个帮助
*/
public class Test
{
public static void main(String []args)
{
System.out.print("java");
}
}

然后你编译的时候,输入javadoc Test.java
接着就会生成一个网页,打开你就懂了

阅读全文

与java注释生成doc相关的资料

热点内容
word删除尾注分隔符 浏览:773
公告质疑需要哪些文件 浏览:608
数据库模型是干什么的 浏览:404
win10的驱动怎么安装驱动 浏览:320
word文件水印怎么取消 浏览:443
rhel6的镜像文件在哪里下载 浏览:571
成功正能量微信头像 浏览:848
wps表格如何恢复数据 浏览:264
linuxc静态库创建 浏览:838
u盘有微信文件但微信恢复不了 浏览:585
苹果的网站数据是什么 浏览:22
ps滚字教程 浏览:237
win7网络邻居如何保存ftp 浏览:186
安卓客户端代理服务器 浏览:572
编程用苹果 浏览:659
51虚拟机的文件管理在哪里 浏览:13
win10系统有没有便签 浏览:722
java引用传递和值传递 浏览:109
oracle下载安装教程 浏览:854
php筛选数据库 浏览:830

友情链接