草庐IT

javadocs

全部标签

java - 使用具有合理 doclint 参数的 maven JavaDoc

有很多关于如何在Java8中关闭JavaDoclint功能的信息。信不信由你,今天我决定使用这个功能来修复我的JavaDocs。但是,在其标准配置中,它会提示每一个可能丢失的@param和@return。从我在Java8javadoctechnotes的JavaDoc文档中看到的内容我选择的选项是-Xdoclint:all,-missing。这应该包括所有检查,但不包括对错过文档机会的投诉。Maven配置如下所示:org.apache.maven.pluginsmaven-javadoc-plugin2.10.4-Xdoclint:all,-missingfalsedefaultjav

java - Maven javadoc 搜索重定向到 "/undefined/.."url

我已经使用javadocmaven插件3.0.1和Java9生成了javadoc。但是,当我使用新的搜索功能并选择一个类时,它会重定向到“找不到文件”...url中有undefined(例如“../target/site/apidocs/undefined/com/mycompany/MyClass.html”),如果将其删除,将正确加载页面。能否请您帮助我进行正确的配置以生成java文档(去掉这个undefined),以便搜索功能能够正常加载html页面?org.apache.maven.pluginsmaven-javadoc-plugin${version.maven-javad

java - 如何在 sbt 中为 Scala-only 项目生成 javadoc 风格的文档?

我在sbt下有一个Scala项目。我想为它生成一个javadoc,因为项目API的大多数用户都是Java开发人员。这可能吗? 最佳答案 我假设您想要JavaDoc格式的文档,以便让习惯Java库的人熟悉一些东西?typesafe中有一个名为GenJavaDoc的项目,它可能就是您正在寻找的项目。它以与javadoc非常相似的格式为scala库生成文档。它可以集成到sbt构建中。Akka有一个非常完善的javaapi,而且Akka的许多用户来自java世界,所以显然他们对此有需求。TheprojectrepositoryAkkajap

java - javadoc中的@jls是什么意思?

@jls4.3.2。类对象@jls9.8函数式接口(interface)@jls9.4.3接口(interface)方法体@since1.8*/在一些核心java类中发现了这个javadoc,这是什么意思?什么时候用在写javadoc? 最佳答案 @jls表示对JavaLanguageSpecification的一部分的引用.例如:4.3.2TheClassObject9.8FunctionalInterfaces9.4.3InterfaceMethodBody您问题中的最后一个注释@since用于指示首次创建记录的类或方法的Jav

java - 使用自上而下的方法在 Java 中设计 API - 编写 Javadoc 是最好的起点吗?

每当我需要用Java设计API时,我通常会先打开我的IDE,然后创建包、类和接口(interface)。方法实现都是虚拟的,但javadoc很详细。这是解决问题的最佳方式吗?我开始觉得API文档应该是第一个被搅动出来的——甚至在第一个.java文件被编写之前。这有几个优点:API设计者可以完成设计和规范,然后将实现拆分给几个实现者。更灵活-设计更改不需要在java文件中来回寻找编辑javadoc注释的位置。还有其他人同意这个观点吗?如果是这样,您如何着手进行API设计?此外,是否有任何可能有用的工具?甚至可能是某种基于注释的工具生成文档然后生成骨架源代码(有点像模型到代码生成器)?我遇

java - Javadocs '#' 中 '{@link #method}' 的用途是什么?

Javadoc链接标记中的散列#的用途是什么?/**Call{@link#method}todofoo.*/ 最佳答案 Javadoc使用#作为类和方法/构造函数签名或字段名称之间的分隔符,以避免模棱两可的链接。Javadoc@link和@see标签可用于引用包、类和类中的特定方法/构造函数或字段。这可能并不明显,但拥有例如包“a.b”中的类“c”和包“a”中的类“b”在同一项目中具有名为“c”的字段。指向“packagea.b,classc”的Javadoc链接将写为a.b.c,而指向“packagea,classb,fieldc

java - intellij 快捷方式 - 如何折叠所有 javadocs + 方法实现

我找不到一些IntelliJIDEA快捷方式。当我去上课时,我希望能够只看到方法签名而没有其他详细信息。这就是我的意思。之前:之后:这个有捷径吗? 最佳答案 CodeFoldingofawholefileisCtrl+Shift+MinusandCtrl+Shift+Numpad_Plus或在菜单中chooseCode|Folding|CollapseAllorCode|Folding|ExpandAll.更多代码折叠的快捷方式:DocsforCodeFoldingShortcuts 关

java - 如何在基于 NetBeans 的项目中将 javaDoc 添加到我的 Java 代码中?

如何将JavaDoc或其他文档添加到netbeans?我尝试用这种方式:Tools>>JavaPlatform>>JavaDocTab>>JavaDoc.zip(inmydesktop)但在编辑器中,当我在工具提示文本中按Ctrl+Space时显示此消息:Javadocnotfound.EitherJavadocdocumentationforthisitemdoesnotexistoryouhavenotaddedspecifiedJavadocintheJavaPlatformManagerortheLibraryManager.我尝试重新启动NetBeans,但结果是这样的:

java - 如何快速创建指向 Eclipse 中元素的 Javadoc 链接?

我想从我的Javadoc中轻松创建指向类、方法、字段等的链接,而不必输入完整的表达式,例如{@linkAllowAllHostnameVerifier}。在Eclipse中执行此操作的最快方法是什么? 最佳答案 如果您还没有您正在记录的元素的Javadoc,请按Shift+Alt+J。使用AllowAllHostnameVerifier示例,在您想要链接的Javadoc注释中使用自动完成:键入AAHV然后Ctrl+空间。通过按↓然后按Enter从自动完成选项列表中选择{@linkAllowAllHostnameVerifier}。

JavaDoc 接口(interface)评论

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭7年前。Improvethisquestion我有一个接口(interface)A,它有方法x、y和z。我是这样评论类(class)的:/****A.java*Interfaceclassthathasthefollowingmethods.**@authorMyName*@sincemm-dd-yyyy*/publicinterfaceA{//methoddescriptionforxvoidx();//methoddescript