JavaDoc API 读取 class 中的信息 (注释、方法名、参数、返回值等)

最新推荐文章于 2024-11-24 16:06:28 发布
置顶 最新推荐文章于 2024-11-24 16:06:28 发布
阅读量1.7k 收藏 2
点赞数 1
分类专栏： 功能模块 Android基础 Java Android项目功能
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/BlogRecord/article/details/97622238
版权
该项目通过JavaDoc API读取class中的注释、方法名、参数和返回值，简化了API生成和代码规范检查的过程。JavaDocMain类提供使用示例，而JavaDocReader作为核心类负责信息读取。此外，还包含了代码排版检测和DevUtils API的生成实现。
摘要由CSDN通过智能技术生成

JavaDoc Github

About

该项目主要是通过 JavaDoc API 读取 class 中的信息 (注释、方法名、参数、返回值等), 方便大家通过了解 JavaDoc API 并能够实现节省时间、提高效率的工具

编写该项目主要是提高效率, 方便自己工具类项目生成 API 以及检测代码规范、中英字符间距、@param、@return 等容易遗漏且复杂耗时的操作

JavaDoc

使用演示类 JavaDocMain 介绍了使用方法, 以及可获取信息
项目类结构 - 包目录
最低0.47元/天 解锁文章
使用jdk的sun java doc工具包获取类中方法的参数注释信息，方法签名注释信息，返回值注释信息，方法上的注解信息
08-08 1964
某日工作时需要将类中所有方法详细信息收集到excel中，包括方法的参数注释信息，方法签名注释信息，返回值注释信息，方法上的注解信息，而我需要列举的类方法有80 90个那不是累死人。突然想到曾经写过通过javadoc获取注释信息的功能，而注解信息，通过jdk暴露出来的api 是获取不到，需要另辟蹊路，经过研究我发现sun.javadoc中有注解的信息，只是没有暴露出来，在他的com.sun.tool...
Java、Javac、Javadoc查找class路径总结
u011382381的博客
01-15 3371
这两天在用Eclipse编译文件的时候遇到些class无法找到的问题，于是想重新学习java查找class的机制。本文内容参考官方文档Java Tuturial How Classes are Found和Setting the Class Path。 1、Java加载类 Java 按照加载顺序将类分为三种：引导类、扩展类和用户类，分别依次载入。 引导类是如rt.jar等共同构...
Javadoc的注释方式
最新发布
m0_73837751的博客
11-24 1166
***/@标签描述方法的参数。描述方法的返回值。描述方法可能抛出的异常。提供相关链接，用于引用类、方法或文档。标记方法或类已废弃，建议开发者避免使用。表示从哪个版本开始引入。@since 版本号嵌入式链接，用于引用类或方法。标注类或接口的作者。标注类的版本号。用于嵌入代码片段，常用于描述参数或示例。
java:通过javadoc API读取java源码中的注释信息(comment)
qq_37771131的博客
07-29 929
如何从java源码中读取注释信息?(注意不是指通过反射读取annotation类,是comment,就是程序员在源码中加的注释) 比如： /** * 使用当前类的class loader加载工具对象 * @param classname * @return * @throws ClassNotFoundException * @throw...
JavaDoc与注释
weixin_50303989的博客
01-22 843
JavaDoc与注释 javadoc命令是用来生成自己API文档的，（API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。） javadoc可以将文档的注释信息生成一个帮助文档，类似于java的API。 参数信息 @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @r
JAVA注解篇
javaYY_的博客
07-09 286
目录Java将注解抽取到doc文件中： JDK中预定义的一些注解4.在程序中使用（解析）注解：应用于说明程序，给计算机看的。注解也叫做元数据，一种代码级别的说明。他是JDK1.5之后版本引入的一个特性，与类，接口，枚举是在同一个层次。它可以声明在包，类，字段，方法，局部变量，方法参数等的前面，用来对这些数据进行说明。1.JDK1.5之后新特性2.说明程序的3.使用注解：@注解名称1.编写文档：通过代码里标识的元数据（注解）生成文档【生成文档doc文档】2.代码分析：通过代码里标识的元数据(注解)对代码进行分
JavaDoc【注释】生成API（开发文档）详解
kertnudserf56968的博客
02-13 2149
Javadoc 是 Java 自带的一种工具，其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
`java`学习笔记（十一）`javadoc`注释
qq_45205390的博客
10-21 393
java学习笔记（十一）javadoc注释 文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。 Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码中抽取类、方法、成员等注释，然后形成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的标签注释，在程序编写完成后，通过 Javadoc 就形成了程序的 API 帮助文档。 API 帮助文档相当于产品说明书，而说明书只需要介绍那些供用户使用的部分，所以 J
提取javadoc_使用JavaParser从源文件中提取JavaDoc文档
最佳 Java 编程
06-28 1017
提取javadoc 很多人正在使用JavaParser实现最不同的目标。 其中之一是提取文档。 在这篇简短的文章中，我们将看到如何打印与类或接口关联的所有JavaDoc注释。 可以在GitHub上找到代码： https : //github.com/ftomassetti/javadoc-extractor 获取类的所有Javadoc注释 我们正在重用DirExplorer，在提出了支...
Java-文档注释例子
09-04
1. 提供自动生成API文档：Java的Javadoc工具可以读取源代码中的文档注释，生成HTML格式的文档，方便开发者理解和使用API。 2. 提高代码可读性：通过添加详细的描述，让其他开发者更容易理解代码的功能和用法。 3. ...
Javadoc生成的详细操作教程
奈何的人生
06-02 1万+
Javadoc命令和使用IDEA来生成doc文档不会哪行，一文详细操作让你掌握Javadoc
根据接口类名称和jar文件读取class文件
06-17
根据接口类名称和jar文件读取class文件 可以改造成根据package名读取class文件等等。。。 扩展性很强一读既懂
使用javadoc的api获取代码注释
书生的博客
02-20 2291
通过javadoc获取代码注释 package com.xxx.test; import com.alibaba.fastjson.JSON; import com.sun.javadoc.ClassDoc; import com.sun.javadoc.FieldDoc; import com.sun.javadoc.MethodDoc; import com.sun.javadoc.RootDoc; import java.lang.reflect.Field; /** * @Author
Java获取类或方法上的注解
热门推荐
weixin_39640041的博客
06-30 1万+
Java 获取类或方法上的注解 获取方法 Class Class.getAnnotations() 获取所有的注解，包括自己声明的以及继承的 Class.getAnnotation(Class< A > annotationClass) 获取指定的注解，该注解可以是自己声明的，也可以是继承的 Class.getDeclaredAnnotations() 获取自己声明的注解 Method Method.getAnnotations() 获取所有的注解，包括自己声明的以及继承的 Method.
Javadoc 使用详解 、接口上的注释使用说明、JavaDoc生成API
39660593的博客
03-13 1955
Javadoc 文件的生成(Javadoc I Documentation Generator)原文地址：https://blog.csdn.net/qq_27467365/article/details/83795532 Javadoc 使用详解原文地址：https://blog.csdn.net/vbirdbest/article/details/80296136 JavaDoc生成API原文...
使用JavaParser从源文件中提取JavaDoc文档
最佳 Java 编程
06-05 5097
很多人正在使用JavaParser实现最不同的目标。 其中之一是提取文档。 在这篇简短的文章中，我们将看到如何打印与类或接口关联的所有JavaDoc注释。 可以在GitHub上找到代码： https : //github.com/ftomassetti/javadoc-extractor 获取类的所有Javadoc注释 我们正在重用DirExplorer，在提出了支持类的介绍Java...
javadoc实现Java开发规范.pdf
11-07
在这个例子中，`@param` 标签用于解释方法参数的用途，`@return` 标签描述了方法返回值的信息。这样的注释不仅使代码更易理解，还为Javadoc自动生成文档提供了所需的数据。 类注释通常位于类声明之前，提供了关于类...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值