java:通过javadoc API读取java源码中的注释信息(comment)

如何从java源码中读取注释信息?(注意不是指通过反射读取annotation类,是comment,就是程序员在源码中加的注释) 比如:

    /**
     * 使用当前类的class loader加载工具对象
     * @param classname
     * @return
     * @throws ClassNotFoundException
     * @throws InstantiationException
     * @throws IllegalAccessException
     */

大概很少会有人需要用到这个,不过最近的项目中需要对自动生成的代码中加入原始代码的注释,就需要从原始代码中获取注释。所以需要在程序实现读取源码中的注释信息,网上找了很多文章都想通过分析源码文件(正则表达式)来把注释提取出来,差点被这些文章带到坑里,休息的时候突然想如果javadoc有API可以调用,应该就能通过javadoc来获取完整的注释,而不用自己费力去搞。 google一查,果然javadoc有API的,就在$JAVA_HOME/lib/tools.jar中,官网也提供了完整的文档告诉你如何定制自己的javadoc输出。最关键的一点就是提供一个Doclet 类,利用-doclet参数去替换掉javadoc默认的Doclet,然后你的Doclet类就能获得一个包含完整丰富的结构化信息的注释对象RootDoc.然后你想怎么玩就随你啦。

关于如何在maven中将$JAVA_HOME/lib/tools.jar添加到dependency,参见 参考资料2

package gu.doc;

import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.MethodDoc;
import com.sun.javadoc.RootDoc;

public class JavaDocReader {
    private static RootDoc root;
    // 一个简单Doclet,收到 RootDoc对象保存起来供后续使用
    // 参见参考资料6
    public static  class Doclet {

        public Doclet() {
        }
        public static boolean start(RootDoc root) {
            JavaDocReader.root = root;
            return true;
        }
    }
    // 显示DocRoot中的基本信息
    public static void show(){
        ClassDoc[] classes = root.classes();
        for (int i = 0; i < classes.length; ++i) {
            System.out.println(classes[i]);
            System.out.println(classes[i].commentText());
            for(MethodDoc method:classes[i].methods()){
                System.out.printf("\t%s\n", method.commentText());
            }
        }
    }
    public static RootDoc getRoot() {
        return root;
    }
    public JavaDocReader() {

    }
    public static void main(final String ... args) throws Exception{
        // 调用com.sun.tools.javadoc.Main执行javadoc,参见 参考资料3
        // javadoc的调用参数,参见 参考资料1
        // -doclet 指定自己的docLet类名
        // -classpath 参数指定 源码文件及依赖库的class位置,不提供也可以执行,但无法获取到完整的注释信息(比如annotation)
        // -encoding 指定源码文件的编码格式
        com.sun.tools.javadoc.Main.execute(new String[] {"-doclet", 
                Doclet.class.getName(), 
                "-docletpath", 
                Doclet.class.getResource("/").getPath(),
                "-encoding","utf-8",
                "-classpath",
                "D:/j/facelog/facelog-main/target/classes;D:/j/facelog/db/target/classes;D:/j/facelog/db/sql2java/lib/swift-annotations-0.14.2.jar",
                "J:/facelog/facelog-main/src/main/java/net/gdface/facelog/FaceLogDefinition.java"});
        show();
    }
}

参考资料

1:《javadoc OPTIONS》 2:《JDK tools.jar as maven dependency》 3:《Running the Standard Doclet Programmatically》 4:《Doclet Overview》 5:《stackoverflow:Running the Standard Doclet Programmatically》 6:《A Simple Example Doclet》

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏奇梦博客

Xiuno插件开发,Overwrite 机制说明 PHP 插件 XiunoBBS

我们已经知道了 Hook 机制就是插入合并,那么 Overwrite 就很好理解了。 Overwrite 就是覆盖的意思,Xiuno BBS 的 overwri...

852
来自专栏逸鹏说道

Owin:“System.Reflection.TargetInvocationException”类型的未经处理的异常

异常汇总:http://www.cnblogs.com/dunitian/p/4523006.html#signalR Owin:“System.Reflect...

3365
来自专栏技术专栏

Scala入门与进阶(二)- Scala入门

1063
来自专栏AhDung

慎用Assembly.LoadFile()和Assembly.LoadFrom()

经测这俩方法会锁住文件,导致程序运行期间无法对load过的程序集文件进行更名/删除/覆盖等等操作,考虑用Assembly.Load()文件字节组替代:

844
来自专栏Petrichor的专栏

apt-get install 遇到依赖问题

askubuntu.com/questions/140246/how-do-i-resolve-unmet-dependencies-after-adding-...

1294
来自专栏calvin

扩展htmlhelper.DropDownListFor 支持list数据源和option增加属性

mvc自带的DropDownListFor数据源必须是IEnumerable<SelectListItem>。并且option不支持增加自定义属性。在使用boo...

702
来自专栏林德熙的博客

C# 如何在项目引用x86 x64的非托管代码

因为现在的项目使用的是 AnyCpu 在 x86 的设备使用的是x86,在x64使用的是x64,但是对于非托管代码,必须要在x64使用x64的dll,在x86使...

931
来自专栏技术沉淀

Numpy练习

1293
来自专栏林德熙的博客

使用 Resharper 快速做适配器

如果需要做一个类的重写,需要重新写这个类的所有属性和函数,本文提供一个简单的方法让大家快速重写一个类的所有属性和函数。

351
来自专栏小白的技术客栈

两个微型的函数例子

hello小伙伴们大家好,还记得昨天的函数参数的文章吗?你get到了多少呢?实际的工作中并没有那么复杂,一个通用的函数定义形如: def func_name(*...

3265

扫码关注云+社区