【Javadoc】教程文章相关的互联网学习教程文章

您将如何在Eclipse中将Javadoc导出为.jar文件?

我终于完成了我的项目JConsole Maker.我放入了所有Javadoc注释,并准备导出Javadoc.我就是不知道我可以将其保存到文件夹中,但是是否有任何特定方法可以将其导出到.jar,以便Eclipse开发人员也可以使用它?解决方法:我的答案与您的要求不完全一致,但是这是一种使用关联的Javadoc构建项目(JConsole Maker)的.jar的方法:将javadoc生成到文件夹后,请执行 文件>导出…> Java> Jar文件,然后选中“导出Java源文件和资源”. 然后,您的javado...

如何从许多包含源代码的插件jar文件中生成Javadoc

对于第三方提供的整个插件,我有500多个jar文件,对于每个jar文件,也都有一个源jar文件.但是他们没有提供javadoc. 我希望能够从提供的源jar文件中构建javadocs,但是无法确定javadoc.exe是否会为我执行此操作.我已经好几年没有手动使用它了,所以不熟悉命令行选项. 这里的一位家伙向我展示了如何将源文件导入Eclipse,以便我可以浏览源代码.但是这样做超过500次是非常耗时的练习. 干杯解决方法:因为所有源文件和插件jar都放在同一个目录...

在JavaDoc中包括指向(单元)测试类的链接

在类的JavaDoc中包括(单元)测试类的链接是一种好习惯还是一种好习惯? 到目前为止,我还没有看到它,但是发现它在上课和测试课之间跳转时非常有帮助.我还认为测试用例为使用类提供了很好的例子. 在JavaDoc中反对链接测试用例的论点是什么?解决方法:绝对不是好习惯. 出于一个简单的原因:生产代码的责任在于其“生产工作”.生产代码不负责提供有关测试设置的信息!有时,有一种受程序包保护的方法很实用,该方法允许您检查对象的内部状...

如何使Gradle Javadoc插件荣誉Lombok处理?【代码】

我有一个标准的gradle java项目,我使用了lombok.我班有一个@NoArgsConstructor(access = AccessLevel.PACKAGE) 但是当我运行./gradlew javadoc时,报告的可见性是公开的.有什么灵巧/快速的方法吗?还是我必须在delombokked源上运行delombok并运行javadoc?以及如何用gradle做到这一点? gradle 3.3,龙目岛1.16.14解决方法:do i have to run delombok and run javadoc on delombokked sources?我已经看到人们在使用lombokked项目时抱...

使用具有(模拟的)可选/默认参数的函数编写Javadoc【代码】

我有一些C代码的Java包装器,其中通过手动重载相关方法来模拟默认参数. [示例在Does Java support default parameter values?中.]在一种情况下,C fn具有3个可选参数,因此我不得不用Java编写8个方法. 现在,我想为上述方法编写JavaDocs.有什么办法可以避免将相同的文本写8次?除了冗长之外,这还将是维护的噩梦… EDit:这是一个玩具示例,说明了方法的签名:void foo(int i, String s, double d); void foo(int i, String s); void foo...

Javadoc中的Escape @ Character【代码】

我知道以前已经有人问过这个问题,但是那里的答案仅适用于较早的JVM.我在8岁.我有一个像这样的javadoc:* <pre>* {@code* * import javax.ws.rs.Path;* * import com.ziath.handheldserver.scripts.AbstractHandheldScript;* import com.ziath.handheldserver.scripts.valueobjects.ScriptStatus;* import com.ziath.handheldserver.scripts.valueobjects.WidgetList;* * import org.slf4j.Logger;* import org.slf4j.LoggerFactory...

OSGi版本注释的怪异Javadoc错误(带有jdk12)【代码】

随着从Java 11到Java 12的更改,我们现在在包含OSGi版本注释的程序包信息文件上生成Javadoc时看到一个奇怪的错误. 源代码是:@Version("1.3.0") package org.apache.jackrabbit.oak.commons;import org.osgi.annotation.versioning.Version;错误是:[ERROR] C:\projects\apache\oak\trunk\oak-commons\src\main\java\org\apache\jackrabbit\oak\commons\package-info.java:17: error: unknown tag: Version [ERROR] @Version("1.3.0...

如何从Javadoc中排除已弃用的公共方法?

我想为我的班级生成javadoc.“生成Javadoc”命令为我提供了为可见性为Private / Package / Protected / Public的成员创建Javadoc的选项.但是有一些我不想包含在Javadoc中的公共方法.如何为该Javadoc生成器确切指定要包括的成员/方法和不包括的成员/方法? (我使用Eclipse 3.4.2) 编辑:你们中的一些人问我要这样做的原因是什么.原因是我有一些我不希望存在的方法,但为了向后兼容,我仍然需要它们.我将它们标记为@deprecated,以便尝试...

javadoc @docRoot【代码】

谁能给我看那个javadoc标签的例子吗? 我不太了解如何在代码中使用它解决方法:javadoc documentation有几个很好的例子.它始终指向文档的根目录,因此,如果要在每个页面上包含某些内容,则可以使用它来查找javadoc根目录,因为相对路径在每个页面上都不同 例如,要将公司的徽标包含在每个生成的文档页面的顶部,可以将logo.png放在文档的根目录中,然后添加:<img src="{@docRoot}/logo.png">到javadoc标头

java-java5-javadoc注释【图】

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。 javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。 // 注释一行 / * */ 注释若干行 /** ……*/ 注释若干行,写入Javadoc文档...

android-如何使用ADT r17生成Javadoc【代码】

当人们将ADT和SDK更新到最新版本r17时,似乎会出现许多问题.我在为使用Android蓝牙库的Android JAR项目生成Javadoc时遇到问题.使用版本r16,以下技巧起作用:-classpath "C:/Program Files (x86)/Android/android-sdk/platforms/android-13/android.jar" -linkoffline http://d.android.com/reference "file:/C:/Program Files (x86)/Android/android-sdk/docs/reference"但是,当我更新到r17之后,它再次发生.我删除了classpath行,因为...

JavaDoc:@链接到MyClass.class【代码】

{@link Foo.class}是否有正确的JavaDoc语法?这和{@link Foo#class}都不起作用.还是不可能? 让我扩大一点: 我有一个函数registerException(Class<?extended Exception> exceptionClass),该函数通过诸如registerException(IOException.class)之类的方法被调用,并开始为其编写以下JavaDoc:/*** Registers a new {@link Class Class<? extends Exception>}* (e.g. <code>IOException.class</code>} that can be flattened by this...

是否应在JavaDoc中描述未经检查的异常?【代码】

我有以下代码:public User getUserById(Long id) { checkUserExists(id); return repo.findOne(id); }private void checkUserExists(Long id) {if (id == null || !repo.exists(id)) {throw new NoUserFoundException("No User exists with id: " +id);} }根据甲骨文:“Unchecked exceptions do not need to be declared in a method or constructor’s throws clause if they can be thrown by the execution of the method or ...

看到所有扩展javadocs中当前查看类的类吗?【代码】

冒着听起来令人难以置信的愚蠢和得到一个相当惠顾的答案的风险,我如何查看所有其他扩展javadocS中当前“已查看类”的类? 即Object a {}Object b extends a {}查看a,有一种方法可以查看“扩展了该类A的所有类”……因此显示为“类B”. 编辑: 感谢那.在我确定必须有子类的那一刻,我正在阅读一个API……事实证明不是!有趣.解决方法:Javadoc应该自动生成“直接已知子类”部分,在这种情况下,它将列出类B. 您无需执行任何操作即可显示...

与JSE JavaDoc相比,可以存在哪些类层次结构差异?【代码】

我目前正在Maven后期编译任务中生成一些ASM代码.在Java 6中,引入了StackMapTable来表示堆栈上的数据类型,这在更高版本中是必需的.所以我会自动确定可以在堆栈上的最具体的类.现在我遇到了一个问题,在我的VM ThaiBuddhistDate和HijrahDate中继承了ChronoLocalDateImpl,因此它将在StackMapTable中创建此类型,这显然会在其他VM(甚至是版本)中崩溃.所以我想,也许我应该将计算更改为最小强制性的,这可能会(从理论上)引起类和接口的类似问...