「java导出方法内注释」java导出方法内注释是什么
本篇文章给大家谈谈java导出方法内注释，以及java导出方法内注释是什么对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。
本文目录一览：
- 1、java编程题目！提取java源代码中的注释生成javadoc或txt文件
- 2、如何将java程序中的文档注释提取出来生成说明文档
- 3、java中如何自动生成注释
- 4、用java正则表达式提取java程序中的注释
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技术，是从源代码中抽取类，方法，成员等文档注释形成一个与源代码配套的API帮助文档，用一套特定的标签做注释，在编程结束后，通过javadoc.exe生成开发文档。
java中如何自动生成注释
你说的应该是生成javadoc吧?
最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:
javadoc -d docs -subpackages com.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 不显示状态消息
-Jflag 直接将 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 的全限定名称
-tagletpath Taglet 的路径
-charset charset 用于跨平台查看生成的文档的字符集。
-helpfile file 包含帮助链接所链接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab tab length 指定源中每个制表符占据的空格数
-keywords 使程序包, 类和成员信息附带 HTML 元标记
-stylesheetfile path 用于更改生成文档的样式的文件
-docencoding name 指定输出的字符编码
用java正则表达式提取java程序中的注释
正则的效率非常低，有很多不用正则的好方法：
一，示例 某java程序
比如说一个Test2.java,将其保存在C盘根目录下，代码内容如下
/**
* @author xxx
*
*/
public class Test2 {
/* main method */
public static void main(String[] args) {
//a
int a =5;
//b
int b =5;
//a+b
System.out.println(a+b);
}
}
二，提取注释程序，将所有注释放到一个List里面，最后打印输出：
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.List;
public class Test {
private static final String javaFilePath = "C:/Test2.java";
public static void main(String[] args) throws IOException {
ListString comments = new ArrayListString();
BufferedReader bfr = new BufferedReader(new InputStreamReader(new FileInputStream(javaFilePath)));
String line=null;
while((line=bfr.readLine())!=null){
line = line.trim();
if(line.startsWith("//")){
comments.add(line);
}
else if(line.startsWith("/*")line.endsWith("*/")){
comments.add(line);
}else if(line.startsWith("/*")!line.endsWith("*/")){
StringBuffer multilineComment = new StringBuffer(line);
while((line=bfr.readLine())!=null){
line = line.trim();
multilineComment.append("\n").append(line);
if(line.endsWith("*/")){
comments.add(multilineComment.toString());
break;
}
}
}
}
bfr.close();
for(int i=0;icomments.size();i++){
System.out.println("第"+(i+1)+"处注释: ");
System.out.println(comments.get(i));
}
}
}
三，输出结果：
第1处注释:
/**
* @author xxx
*
*/
第2处注释:
/* main method */
第3处注释:
//a
第4处注释:
//b
第5处注释:
//a+b
java导出方法内注释的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于java导出方法内注释是什么、java导出方法内注释的信息别忘了在本站进行查找喔。