我有2节课.第一个包含已弃用的方法.第二个类实例化第一个类并使用其弃用的方法. 编译器确实显示警告但是： 问题：为什么在运行javadoc Test.java之后,在生成的Java文档中没有列出已弃用的方法？ 这是代码：import java.lang.annotation.*; class Tester{private int a = 1;/*** @deprecated* This is deprecated because I do not like it*/@Deprecatedpublic void afficher(){System.out.println("a is: " + a);} } public class ...
我有一个使用source / target = 1.9 / 1.9的多模块Gradle Java项目.有两个模块,my.base和my.dependsOnBase. my.base模块没有其他依赖项：module my.base {exports my.base.foo;exports my.base.bar; }my.dependsOnBase模块只有一个依赖项,即my.base：module my.dependsOnBase {requires my.base;exports my.dependsOnBase.baz; }当我运行$gradle javadoc时,它在my.base上工作正常.但是当它到达my.dependsOnBase时,我得到以下错误输...
我的课程如下：@Data @Builder public class Foo {private String param;/** My custom builder.*/public static FooBuilder builder(String _param){return builder().param(_param);} }我收到以下错误：[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.4:javadoc (default-cli) on project foo: An error has occurred in JavaDocs report generation:[ERROR] Exit code: 1 – /home/worksp...
对于重写方法,Eclipse生成如下的javadoc：/* (non-Javadoc)* @see com.ncube.qtpokertest.listeners.PlayerChangeListener#* nameChanged(com.ncube.qtpokertest.events.PlayerChangeEvent)*/实际上,它不是javadoc评论,但它可以正常工作. Checkstyle将此评论标记为警告.如何调整checkstyle以禁用此警告？解决方法:如果我记得没错,你应该只使用@Override注释,而不是编写/生成任何文档.这应该避免checkstyle警告,但仍然会生成一个指向...
我正在尝试为多个包生成java文档,所以我有一个index.html,我可以通过编写为单个包生成它们,javadoc packages/mypackage1/program/*.java但我不能让它适用于多个包.我尝试使用javadoc @packages但是我得到了error - cannot read packages <access is denied>任何想法都会很棒!!解决方法:javadoc -d [DESTINATION_FOLDER] -sourcepath [SOURCE_FOLDER] -subpackages [PACKAGE1]：[PACKAGE2] 例如,如果您的层次结构是： > /home/my_pr...
我试图回答这个问题,我相信Javadoc会解决这个问题： 您已经发现某个(其他优秀)类中的方法存在安全问题,并且您希望告诉用户再使用该方法不是一个好主意.你怎么做到这一点？解决方法:我建议弃用该方法. How and when to deprecate APIWhen you design an API, carefully consider whether it supersedes anold API. If it does, and you wish to encourage developers (users ofthe API) to migrate to the new API, then deprecate ...
在NetBeans中,我在尝试为Maven项目生成JavaDoc时遇到以下错误.Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc (default-cli) on project Heur: An error has occurred in JavaDocs report generation: Exit code: 1 - C:\Users\Admin\JavaProjects\Heur\src\main\java\com\heur\App.java:27: error: malformed HTML * @author MyName <myemail @ gmail.com>我不明白错误,据我所知,@ autho...
假设我正在编写一个扩展抽象类“Work”的类“MyWork”.现在,假设我在“MyWork”中需要的所有方法都已经声明并且已经将它们的JavaDoc写在“Work”中.我还应该在“MyWork”中添加JavaDoc吗？ 干杯!解决方法:这取决于.如果您没有覆盖任何方法,则无法添加Javadoc(仅限于类级别).将一些Javadoc添加到类中解释其存在的原因是有意义的. 如果您要覆盖方法,可以像这样编写Javadoc：/*** {@inheritDoc}* This implementation also does...*/
我正在使用Intellij Idea,当我开始生成JavaDocs(通过Tools – > Generate JavaDoc)时,我会抛出一个IllegealArgumentException而没有关于出错的信息. 即使没有JavaDoc注释,在使用模块中的每个单独文件进行测试时也会发生这种情况. 这是我得到的堆栈跟踪的示例：java.lang.IllegalArgumentException at sun.net.www.ParseUtil.decode(ParseUtil.java:202) at sun.misc.URLClassPath$FileLoader.<init>(URLClassPath.java:1204) at s...
我曾经使用Doxygen,它生成了一份很好的报告,列出了尚未记录的项目.有没有什么办法可以在Eclipse Java项目中生成缺少Javadoc注释的类似报告？解决方法:这不是“报告”,但您可以将Eclipse配置为报告丢失(和格式错误)的JavaDoc注释作为警告甚至错误. 您可以在每个工作区(Window – > Preferences – > Java – > Compiler – > Javadoc)或每个项目的基础上(选择项目 – >右键单击 – >属性)执行此操作 – > Java编译器 – > Javad...
有谁知道我在哪里可以找到适用于iSeries的IBM Developer Kit for Java的Javadoc？ information center似乎没有它.我能找到的只是Javadoc for iSeries特定的JAAS. 具体来说,我正在寻找用于编写Java存储过程的Javadoc(主要是com.ibm.db2.app包).解决方法:看一下红皮书Stored Procedures, Triggers, and User-Defined Functions on DB2 Universal Database for iSeries
据我所知,getter / setter应该总是复制,以保护数据. 但是,对于我的许多类,让getter返回对所请求属性的引用是安全的,因此以下代码b = a.getB(); b.setC(someValue);实际上改变了对象a的状态.如果我能证明我的课程没问题,以这种方式实施getter是一种好习惯吗？是否应该通知用户,例如在Javadoc中？我认为这会破坏实现隐藏范式,所以,我是否应该总是假设a的状态没有改变,并调用setterb = a.getB(); b.setC(someValue); a.setB(b);提前致...
如果项目名为foo,我想为不同版本的单独目录发布Javadoc,例如： me.github.io/foo/1.0/apidocs/me.github.io/foo/2.0/apidocs/ 这里讨论类似的问题：https://github.com/github/maven-plugins/issues/22但似乎问题没有解决解决方法:我在Github上使用javadoc.io为我的开源项目托管javadoc,然后从readme.md和github页面链接到那个(例如这里是我的一个项目的最新版本的javdoc：http://www.javadoc.io/doc/com.aol.simplereact/simple-r...
单行注释：//这里是单行注释 多行注释：/**/这里是多行注释，可以多行 JavaDoc注释：使用“/**“开始和“*/“结束，用来注释类、属性和方法等 比如：
我在我的项目中使用Ivy,使用Ivy Eclipse插件. 似乎下载并添加到我的项目中的某些罐子是javadoc罐子,而不是带有实际代码的罐子.注意 – 所有罐子都不会发生这种情况. 例如,将其添加到我的ivy.xml文件中：<dependency org="junit" name="junit" rev="4.8.2"/>导致junit的javadocs被下载并添加到我的类路径中： 这打破了我的项目的编译,因为没有单元测试工作. 这个工作正常,直到我添加了对Spring的引用,一切都破了.我已经尝试删除引用...