Tag: javadoc
如何用Java文档记录我的Java方法？
我希望当我将鼠标hover在一个方法上时，我能够看到我的文档，当我将鼠标放在Java的方法上时，该方法的function我知道/ ** * /是如何完成的但是： 你如何解释Params代表什么？ 如何创建新行，或使单词变为粗体或斜体？
如何将方法的Javadoc复制到其他方法的Javadoc中？
我知道有@inheritDoc ，但它只适用于覆盖其他方法的方法。 我有几个带有许多委托方法的类（ 不会覆盖其他方法）。 他们的Javadoc可以“inheritance”（更确切地说：复制）吗？ /** here I need the copy of wrappedMethod’s Javadoc */ public void delegateMethod(Object param){ innerSomething.wrappedMethod(param); }
如何使gradle构建Javadoc警告失败
我正在使用Java 7（尽管使用1.6编译）来编译类和javadoc。 我已经消除了所有出现的javadoc警告，但是如果有任何javadoc警告，那么想法是让构建失败。 使用Java 8，这是默认行为。 但是，在警告方面它也更加严格（如果方法没有列出所有@params或@returns，我们不希望发出警告）。 另外，我不认为公司很快就会转向8，所以这是一个没有实际意义的问题。 我希望有一些简单的标志设置为gradle失败，如果有警告（只有failonError）。 我在想的是刮掉javadoc进程的控制台输出。 如果该输出包含警告，那么我知道有警告，并且构建应该失败。 这是我的build.gradle中的javadoc块： task gendocs(type: Javadoc) { options.stylesheetFile = new File(“./assets/doc_style.css”) options.windowTitle = “OurTitle” options.memberLevel = JavadocMemberLevel.PROTECTED options.author = true options.linksOffline(‘http://d.android.com/reference’, System.getenv(“ANDROID_HOME”) + ‘/docs/reference’) String v = “${SEMVER}” version = v.replace(“_”, ‘.’) destinationDir = new File(“${BUNDLE_FOLDER}/docs/api”) source = sourceSets.main.allJava classpath += configurations.compile } 所以，如果没有更简单的方法来做到这一点，我如何检查javadoc的控制台输出来刮掉它？
是否可以从JavaDoc创建Java类？
问题在于：目前我的团队为供应商工作，他们从他们的库中为我们提供了一个巨大的JavaDoc规范，但是没有为.jar文件提供存根或实现。 我们已经与他们交谈，但他们将在2到3周内提供.jar文件。 我不想等待这个时间来开始我们的开发，所以这里的问题是： 仅提供JavaDoc .html文件，是否有任何工具（免费/开源）可用，因此我们可以创建一个.jar（或一堆.java / .class文件），使我们能够编译我们的代码？
如何在eclipse中导入com.sun.javadoc。*？
导入com.sun.javadoc eclipse报告我这个错误“导入com.sun.javadoc不能被roselved”似乎没有安装包。 查看网站http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/doclet/spec/index.html?com/sun/javadoc/package-summary.html只有API是显示但我无法下载任何东西。 我能怎么做
Javadoc使用@value在内部类常量上显示值
我有一个内部类，它声明一个常量，并希望使用@value注释在封闭的顶级类的Javadoc中显示它的值。 例如： /** * {@value #FOO_CONS} // this displays well * {@value #BAR_CONS} // this does not work (checked in the latest Eclipse) * {@value Bar#BAR_CONS} // this does not work, either */ public Foo { public static final int FOO_CONS = 1; static class Bar { public static final int BAR_CONS = 42; } […]
Eclipse：添加javadoc
我怎么能在eclipse中为不同的包添加javadoc。 举个例子： 我想在eclipse中为hibernate添加所有javadoc，但我不知道如何。 我读过这篇文章如何在Eclipse中添加hibernate javadocs？ 但是我不想得到hibernate工具，因为我已经使用了STS而且我不理解其他注释。 我在Ubuntu上使用eclipse。
Javadoc如何处理Java 9中模块的可见性？
Javadoc工具基于可访问性修饰符生成文档。 默认情况下，它记录所有public和protected类，字段和方法。 可以使用以下选项更改此设置： -上市 仅显示公共类和成员。 -protected 仅显示受保护的公共类和成员。 这是默认值。 -包 仅显示包，受保护和公共类和成员。 -私人的 显示所有类和成员。 Java 9引入了模块的概念，项目Jigsaw将其应用于现有的JDK。 Mark Reinhold的演讲（关于模块的一系列讨论中的第三篇）展示了public修饰符现在如何具有不同的可访问性级别，具体取决于模块的可见性（通过exports ）： 公开给大家 公开但仅限于特定模块 仅在模块内公开 由于现在并非所有公共成员都可以访问，因此继续使用相同的Javadoc生成方案就没有多大意义了。 只有那些暴露在“足够”水平的成员才应该被记录下来。 Javadoc模块是否可识别？ 除了上面的命令选项还有处理额外曝光层的命令选项吗？ 对于仅暴露给特定模块的公共成员，Javadoc是否列出了这些，如 public static void getDefaultThing() ？
禁用Gradle中的所有JavaDoc
一些研究后的一般更新 我想构建我的项目运行gradle 2.0 ，在控制台中使用gradle build我被困在JavaDoc代。 我正在使用Java 8，精确地使用jdk1.8.0_66和jre1.8.0_66 。 现在，当我想在我的powershell中构建我的项目键入gradle build ，我收到此错误： 5 errors 10 warnings :my-subproject1:javadoc FAILED FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ‘:my-subproject1:javadoc’. > Javadoc generation failed. 一个样本错误和一个样本警告： C:\some\long\path\MyClass.java:37: error: @param name not found * @param appCode ^ C:\some\long\path\MyOtherClass.java:37: warning: no description for @param * @param […]
如何为javadocs创建可分发的jar？
我创建了一个我作为JAR文件发布的API。 它是专有的，所以我不得不从中删除源文件。 我目前包含一个单独的/ doc文件夹，其中包含Eclipse的export-to-javadoc向导的输出。 不错，但我想更进一步。 我想将javadocs作为jar文件分发，可以很容易地将其放入包含我的API的jar文件的未来项目中。 我知道我已经看过它用我用过的其他发行版多次这样做了，但我没有找到任何运气。 最终目标是允许未来的开发人员轻松访问hover在评论和这种性质的事物上。 谢谢！
