草庐IT

non-javadoc

全部标签

java - 为外部库编写 JavaDocs

我的情况是我有一个来自第三方的外部编译库(jar),没有JavaDocs。在开发过程中,我想通过测试和使用从第3方网站获得的非常有限的文档来记录类和方法。我的最终目标是拥有一个JavaDoc文档,我将能够在IntelliJ中使用它来进行代码提示和文档查找?所以我的问题是,是否可以将JavaDocs写入我将能够导入的已编译的jar文件?也许使用有助于此的工具。 最佳答案 是的。您所要做的就是写出类和接口(interface)以及方法和变量定义,没有任何代码,就好像所有方法都是抽象的一样,然后为它们编写Javadoc注释。这实际上是Su

java - JavaDocs 报告生成中发生错误 :Exit code: 1 - javadoc: error - invalid flag: -author

您好,我面临一些maven插件问题,当我尝试部署java-webservices项目时,我的项目没有下载"maven-javadoc-plugin:2.4"插件,我手动安装了“maven-javadoc-plugin2.5”版本jar到我的.m2/repository。我得到了"AnerrorhasoccurredinJavaDocsreportgeneration:Exitcode:1-javadoc:error-invalidflag:-author".谁能帮我解决这个错误,子pomorg.apache.maven.pluginsmaven-javadoc-pluginjavado

java - 如何使 javadoc 继承适用于外部 API? (使用 Maven2)

当类重写具体方法或实现抽象方法时,Javadoc将自动继承,除非明确重写。或者,至少该工具会尝试执行此操作。它似乎不适用于链接的外部API。例如,当我在我的代码中实现java.util.Map或来自JRE的其他东西时,javadoc不是从JREjavadocs/apidocs继承/复制的。在我的具体情况下,我试图在Maven2Javadoc插件中配置它,但当我直接运行javadocCLI工具时它是一样的。我的Maven2Javadoc插件配置目前如下所示:org.apache.maven.pluginsmaven-javadoc-plugin2.7mavenhttp://downloa

Java 任务控制显示 "Flightrecorder is not supported for non hotspot jvms"

当我试图通过运行JavaMissionControl(jmc)来分析我的本地Java应用程序时,我无法连接到该应用程序。它在左侧Pane中显示的所有JVM进程的描述中显示“非热点JVM不支持Flightrecorder”。我的环境:Windows7,Java8u25因为我无法在网上的任何地方找到这个问题的解决方案,所以我想与将来可能遇到同样问题的其他人(以及我future的自己)分享我幸运地发现的解决方案。 最佳答案 我在这里发布解决方案和导致解决方案的观察结果。当我(碰巧)尝试运行jvisualvm时,它显示错误“无法监视本地Ja

Java8 Effectively Final compile time error on non final variable

我正在尝试将java8forEach循环中的boolean变量更改为非最终的true。但我收到以下错误:在封闭范围内定义的局部变量必须是最终的或实际上是最终的。如何解决这个错误?代码:booleanrequired=false;这是我在函数中创建的变量。现在当我试图改变它时:map.forEach((key,value)->{System.out.println("Key:"+key+"Value:"+value);required=true;});我收到错误:在封闭范围内定义的局部变量必须是最终的或实际上是最终的。为什么会出现这个错误,如何解决? 最佳答案

JavaDoc - 我可以将方法分组吗?

我目前正在为一个具有许多功能的类创建文档。有什么方法可以组织JavaDoc,以便将概述中的方法分为几类? 最佳答案 也许尝试重构它,这样你就不会在一个类中有“许多功能”。最好将代码分成更容易维护、可读性、测试、调试、文档化等的小部分。 关于JavaDoc-我可以将方法分组吗?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/36016497/

java - 为什么/**[newline] 并不总是在Eclipse 中插入包含@param 和@return 的Javadoc 模板?

我在Eclipse中记录代码,并且一直在使用/**后跟Enter来插入Javadoc模板。然而,出于某种原因,这并不总是有效,它会创建用于编写评论的模板,但不会自动插入@param和@return文本。如果我将完全相同的方法复制到另一个类,它将插入完整的模板。如果有人能告诉我为什么它在某些情况下不会这样做,那将是一个很大的帮助。 最佳答案 据我所知,这通常发生在Eclipse不确定您要记录哪种方法时。更可靠的方法是选择要为其创建JavaDoc的方法/类等,然后按ALT+SHIFT+J或右键单击类大纲中的方法并单击源->生成元素注释。

java - 在 Javadoc 的参数标记中放置多行的正确方法是什么?

我找不到任何关于是否可以在javadoc参数中包含多行信息的信息。我正在制作国际象棋引擎,我希望能够解析字符串以生成棋盘。可以像我下面那样做吗?/***Createsaboardbasedonastring.*@paramboardStringThestringtobeparsed.Mustbeoftheformat:*"8x8\n"+*"br,bn,bb,bq,bk,bb,bn,br\n"+*"bp,bp,bp,bp,bp,bp,bp,bp\n"+*",,,,,,,\n"+*",,,,,,,\n"+*",,,,,,,\n"+*",,,,,,,\n"+*"wp,wp,wp,wp,wp,

用于项目文档的 Javadoc

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想记录我正在处理的Java项目。过去,我通常在wiki中记录设计和软件API。然而,在最近使用Mockito之后对于模拟测试,实际javadoc中项目级文档的数量和质量给我留下了深刻的印象。我的问题是,人们通常使用Javadoc来记录项目的更高级别View(例如架构、设计决策等),还是这种信息最好记录在(比方说)wiki中?

java - Spring 3.1 : Non-XML equivalent of annotation-driven transaction management

什么是非XML(在@Configuration中)等同于在Spring3.1中? 最佳答案 Spring3.1有@EnableTransactionManagement用于此目的的注释。 关于java-Spring3.1:Non-XMLequivalentofannotation-driventransactionmanagement,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions