我不想写多余的javadoc注释。如您所见,@paramx在某种程度上是多余的。是否有javadoc标记来设置从B类中的@paramx到A类中的@paramx的引用>或者我可以忽略它吗?/***ClassAconstructor**@paramxpositiononx-axis*/publicA(finalintx){this.x=x;}/***ClassBconstructor**@paramxpositiononx-axis*@paramypositionony-axis*/publicB(finalintx,finalinty){super(x);this.y=y}
关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭4年前。Improvethisquestion有没有一种工具可以用更像Wiki风格的语法代替普通JavaDoc的HTMLish语法来代替javadoc?我的一个问题是我主要阅读源代码形式的JavaDoc。即使对于外部库,我也尝试附加源代码,以便我可以从我的IDE导航到它,检查入口点上方的文档,如果需要,还检查下方的代码。另一个问题是列表和代码示例之类的东西写起来很麻烦,尤其是如果您的IDE坚持要在每一行都加上星号
总结:我遇到了一个有趣的问题,但我不太确定如何侦查它:我们的项目已经build好几个月了我更改了maven-compiler-plugin使用eclipse编译器而不是javac现在当我运行mvnsite,maven-javadoc-plugin失败根据堆栈跟踪,Javadoc工具似乎在Eclipse编译器创建的类文件上崩溃有什么办法可以解决这个问题吗?如果没有,至少有什么方法可以进一步调试它吗?详细信息:我正在使用Java1.6.0_27和Maven3.0.2。我一直在使用javac编译器来构建我们的代码库,但我有兴趣尝试Eclipse编译器,因为它会产生更好的警告(并且在其他方
我想部署一个Artifact连同javadoc和一个Maven站点。我用cleanjavadoc:jarsitedeploysite:deploy(site和site:deploy之间的拆分只是为了避免在deploy失败时部署站点)。现在javadoc创建了两次-一次在javadoc:jar中,一次在site中。是否可以只创建一次并将其用于Nexus中的javadoc-jar和Maven站点? 最佳答案 我很确定插件缺少检查输出是否已经作为Mavensession的一部分生成的检查。验证输出是否在Maven启动后生成将是一个很好的改
我想自定义CheckstyleJavadocVariable规则,这样它就不会提示具有@FindBy注释的字段。classDemo{@FindBy(id="new-button")publicWebElementcreateButton;//但我不知道如何在checkstyle.xml文件中指定它。有人有想法吗?在此用例中不起作用的事情:修改checked类也是无解!SuppressWithNearbyCommentFilter不会起作用,因为它是注释而不是注释 最佳答案 我知道几种解决方案,但所有这些都需要额外的工作。实现自己的J
我被遗留的Java代码库困住了,当您编译它时,它有成千上万的警告。我很想真正修复所有这些警告的来源,但不幸的是,这在我的公司目前不是一个选择(其他事情,如“制造产生收入的新产品”被负责人认为是更高的优先级;想象一下).现在,我可以忍受所有这些警告,如果不是因为它们让我们很难在持续构建服务器的输出中找到实际错误的话。构建服务器仅使用ant调用,没什么特别的,但到目前为止,我还没有找到任何关于如何修改此调用以防止警告输出的信息。遍历代码并在各处添加@SuppressWarnings注释是可行的,但它也几乎与遍历并修复所有警告的来源一样痛苦。所以我真正喜欢的是,如果我能做一些事情:或类似的东
在大多数团队中,有一条规则规定必须将@author和@since关键字用于所有已记录的类,有时甚至是方法。为了专注于重要的事情,我不使用这些关键字,而是依靠这样一个事实,即我可以使用源代码控制管理系统来确定类的作者是谁以及它存在的时间。我相信@author和@since来自版本控制还不普遍的时代,我认为它们现在已经相当多余了。你怎么看这个?现代Java项目应该使用它们吗? 最佳答案 我认为@author标签实际上混淆了事情。首先,如果更新不明智,它就会出错。另外,如果你(不是原作者)改了半个类怎么办?您是否更新了@author?你加
就在几天前,Eclipse在定位Java.io.File等基类的javadoc时工作正常。不过,最近,将鼠标悬停在这些类上只会产生一条消息,指示缺少源代码和javadoc:“注意:此元素没有附加源,在附加的Javadoc中找不到Javadoc。”我终其一生都找不到可以让我重新选择基本文档位置的选项。有谁知道如何解决这个问题? 最佳答案 我现在也遇到过几次这个问题。如果您的工作区中有很多项目并且您不想为每个项目设置javadoc位置,这尤其令人讨厌。引用联机文档确实效果很好,并且有一种方法可以在全局范围内对所有Java库执行此操作:转
简短的问题:是否可以为局部变量创建Javadoc?(我只是想在Eclipse中将鼠标悬停在局部变量上时得到解释)感谢您的任何提示:-) 最佳答案 可以使用注释来完成。创建一个简单的注释类型,如下所示:@Retention(RetentionPolicy.SOURCE)@Target(ElementType.LOCAL_VARIABLE)@interfaceLocalVariableDocumentation{Stringvalue();}并在你的局部变量上使用它:@LocalVariableDocumentation("Averyi
我正在使用第三方库,我已经将其包含在我的项目中。它包含应用程序的类,但没有源代码或Javadoc。正如预期的那样,将鼠标悬停在导入的对象上不会显示任何javadoc。Note:ThiselementneitherhasattachedsourcenorattachedJavadocandhencenoJavadoccouldbefound.在谷歌搜索了一下之后,我遇到了3个版本的jar应用程序.jarapp-sources.jarapp-javadoc.jar看起来app-javadoc.jar只包含html页面,而app-sources只包含.java文件(带有Javadoc注释)。