java 获取代码注释

1.今天来介绍工具获取java代码的注释，以此来编写自动生成文档工具。

代码：
先导入jdk的tools.jar包

public class Doclet {public static class Entry {/**参数名*/public String fName;/**类型*/public String fType;/**说明*/public String fExplain;public Entry(String fName, String fType, String fExplain) {super();this.fName = fName;this.fType = fType;this.fExplain = fExplain;}}private static RootDoc rootDoc;private String javaBeanFilePath;public Doclet(String javaBeanFilePath) {this.javaBeanFilePath = javaBeanFilePath;}public List<Entry> exec() {com.sun.tools.javadoc.Main.execute(new String[] { "-doclet", Doclet.class.getName(), "-docletpath",Doclet.class.getResource("/").getPath(), "-encoding", "utf-8", javaBeanFilePath });ClassDoc[] classes = rootDoc.classes();List<Entry> entrys = Lists.newArrayList();for (ClassDoc classDoc : classes) {FieldDoc[] fields = classDoc.fields(false);for (FieldDoc field : fields) {entrys.add(new Entry(field.name(), Type.type(field.type().typeName()), field.commentText()));}// buffer.append('\t').append("方法").append('\n');// MethodDoc[] methods = classDoc.methods();// for (MethodDoc method : methods) {// buffer.append('\t').append('\t').append(method.name()).append('\n');// buffer.append('\t').append('\t').append('\t').append(method.commentText()).append('\n');// }}return entrys;}public static boolean start(RootDoc root) {rootDoc = root;return true;}public static void main(String[] args) {Doclet doclet = new Doclet("D:\\dev\\java_workspace\\git_pro\\yunji-groupbuy\\yunji-groupbuyapi\\src\\main\\java\\com\\yunji\\groupbuy\\bean\\response\\GroupbuyDetailVo.java");doclet.exec();}
}

上面会将指定的java源文件中的类的成员变量名称，类型，注释返回。

java 获取代码注释相关推荐

Java入门代码注释与编码规范（羊驼）
一.代码注释 1.单行注释 "//"为单行注释标记,从符号"//"开始直到换行位置的所有内容均做为注释而被编辑器忽略 //注释内容 2.多行注释 "/ ...
php 提取注释,PHP获取代码注释的语句 ReflectionClass
php 获取注释代码的需求class test{ /** * @param String $str 字符串 * @return String */ function abc($str){ retur ...
java象棋代码注释_中国象棋程序的设计与实现(十一)--棋盘绘制算法(尽管注释非常详细,完全理解仍有难度)...
上几篇中,我们详细介绍了,棋盘类的定义和关键属性,简要介绍了棋盘绘制算法的骨架. 本篇,我们将详细解读棋盘绘制算法的每一个细节. 强烈建议,大家结合文章末尾的"棋盘截图"来思考绘制 ...
java的注释规范_Java代码注释规范
1,单行(单行)-简短说明: ///... 单行注释: 代码中的单行注释. 最好在注释前有一个空行,并在其后加上与代码相同的缩进级别. 如果无法完成一行,则应使用块注释. 评论格式: 在行首注释: 在 ...
java 注释超链接_java_Java代码注释规范详解，代码附有注释对程序开发者来 - phpStudy...
Java代码注释规范详解代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一在整个应 ...
aop 获取注解注释的方法_带有AOP和注释的Java方法记录
aop 获取注解注释的方法有时,我想记录(通过slf4j和log4j )方法的每次执行,查看其接收的参数,返回的内容以及每次执行花费的时间. 这是我在AspectJ , jcabi-aspects和 ...
连詹姆斯·高斯林（JAVA之父）都要被气疯掉的JAVA代码注释
前言代码注释作为编程语言的"说明文档",它的作用不容小觑.然而,现实的开发中出现了不少不重视代码注释的行为.比如不写注释又命名的不规范,让人看了一头雾水.又比如有些人利用代码注释 ...
Java获取数据库表名、字段名、字段类型及注释等信息
以前有小伙伴在公众号留言问过如何通过java获取数据库的所有表.及表里字段的信息,只是私信回复过. 在最近的项目中架构部提出了一个数据源的配置需求,就是需要配置公司所有系统的数据库.表等信息,便于大数 ...
Eclipse和MyEclipse 手动设置 Java代码注释模板
一.目的 1. 为什么需要注释规范? 注释规范对于程序员而言尤为重要,有以下几个原因: 一个软件的生命周期中,80%的花费在于维护. 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维 ...

java 获取代码注释

java 获取代码注释相关推荐

最新文章

热门文章