草庐IT

javadocs

全部标签

java - 有没有办法使用键盘显示悬停 JavaDoc 帮助?

当我将鼠标悬停在符号上时,Eclipse在工具提示窗口中显示JavaDoc帮助。这很好,但如果我可以在光标位于符号上时从键盘弹出此工具提示,那就更好了。是否有执行此操作的快捷方式?我发现Shift-F2可以打开外部JavaDoc,但我不想这样。我想用鼠标悬停时显示的键盘弹出相同的工具提示。编辑:谢谢,这很快。:)我接受了最快的答案。 最佳答案 尝试在光标位于该词上时仅按F2。它将打开与您将鼠标悬停在其上时相同的弹出对话框。 关于java-有没有办法使用键盘显示悬停JavaDoc帮助?,我

java - 如何在 JavaDoc 中自定义 "Overview"页面?

我希望我的库的javadoc的“Overview”页面本质上是整个JAR的用户/API指南。我知道将package-info.java类添加到包中可以让您编写包级别javadoc,但是在jar级别?我知道我可以将README.md放在项目的根目录中,但我喜欢将README视为库开发人员(即,将维护库)。但JavaDocs是为将使用库的人提供的API指南。 最佳答案 您可以创建一个概览HTML文件并将其放置在源代码树中您喜欢的任何位置。惯例是将其命名为overview.html并将其放在树的根部,但您当然没有义务这样做。事实上,您可以

java - 如何让 Java API Javadocs 出现在 Ubuntu 的 Eclipse 中

我带着文档问题再次来到这里。在我的大学里,当使用Eclipse时,当放置光标时通过JavaAPI方法名称(例如:.size()),我得到关于它的非常好的文档。在家里我得到了Note:ThiselementneitherhasattachedsourcenorattachedJavadocandhencenoinformationcouldbefound.任何快速简单的apt-get修复?提前致谢!!!! 最佳答案 转到您的JRE设置(Window>Preferences>Java>InstalledJREs),选择您当前的设置,然后

java - 在 JavaDoc 中使用 Maven 属性

是否可以使用MavenJavadoc插件在javadoc上扩展Maven属性的范围?例如/***MyAwesomeClass*@version${project.version}**/ 最佳答案 我想你可以这样试试。这是两步过程:首先是将pom属性加载到静态字段中二是使用静态字段设置javadoc属性在src/main/resources中创建一个app.properties内容如下application.version=${project.version}然后像这样启用maven过滤src/main/resourcestrue在应

java - 您如何链接到 javadoc 中的_包描述_(不是类)?

(不,这不是重复的,见下文)就其值(value)而言,这是OracleJDK,7u72。虽然我确实需要链接到包描述,但我无法设法链接到包描述,因为其中提到了重要信息,但我每次都没有这样做;当我尝试{@linkmy.package.name}或告诉人们去@seemy.package.name(甚至是指向包描述的链接外部库),javadoc工具报告找不到链接...那么,我该如何建立这样的链接呢?好的,所以,被告知here是答案,但不是:建议的解决方案仅适用于您自己代码中的包;我希望能够链接到其他库的包描述;我希望此类链接在package-info.java和“普通”类javadoc中也有效

Javadoc 排除导致导入错误

我正在为我公司制作的库调整javadoc。我们希望从并非真正供公众使用的类(主要是内部使用的类)中排除javadoc。该项目使用gradle作为构建系统,我在build.gradle文件中标记了我们要排除的包/类。但是,这会导致错误发生。如果存在指向被排除的类的@link,我希望得到警告或错误,但是当那些被排除的类被简单地导入时它也会抛出错误。有没有办法“包含”类/包,但不为它们导出javadoc?编辑:这是相关的javadoc任务:taskgendocs(type:Javadoc){options.stylesheetFile=newFile("./assets/doc_style.

java - 如何访问 spark javadoc 或来自 java 项目的源代码?

我在IntelliJ14CE上使用Java项目中的Spark。有没有办法导航到Spark源或javadoc?默认情况下,它只显示粗略的反编译代码,没有任何注释。如果有办法的话,我不介意导航到scala代码。但也许插入javadoc会更好,但我在任何地方都找不到它谢谢 最佳答案 我的诀窍是为IntelliJ安装Scala插件,然后我能够通过spark核心(用scala编写)进行导航和调试,尽管项目是用Java编写的,并且正确地看到Javadoc,它是从scala源代码中自动推断出来的。当然,您还需要正确设置Spark源代码,使用Gra

java - Intellij IDEA 格式 JavaDoc

如何格式化return语句,使其也与参数描述对齐(见下图)我希望return语句的第二行至少与第一行对齐,在这种特殊情况下,单词needed应该与单词Some。我在Settings->Editor->CodeStyle->Java->Tab"JavaDoc"中尝试了all设置,但没有找到任何return。这是所需输出的片段:/***Add2toxandmultipliestheresultwithy.**@paramxXparam.*@paramyYparam**@returnSomeverylongreturndescriptionofthereturnstatementevenif

java - 如何自动将所有 javadoc package.html 文件转换为 package-info.java 文件?

我们在项目中使用了很多遗留的package.html文件,我们想将它们转换为package-info.java文件。手动执行此操作不是一种选择(文件太多)。有什么好的方法可以实现自动化吗?我们想转换它们有几个原因:来自javadoc规范:此文件是JDK5.0中的新文件,优先于package.html。不要在同一代码库中混合两种类型的文件为避免Intellij/Eclipse构建将这些*.html文件放在我们的类目录中(并且可能在发布二进制jar中),以便它们的行为与我们的其他普通html资源一样。 最佳答案 如果您运行的不是Wind

java - 使用 Maven 创建一个包含已编译类和 javadoc 的 jar

我正在尝试生成一个包含我们产品的APISDK的jar文件,以便我们的客户可以创建插件并根据我们的API对其进行编译。我们作为APISDKjar的一部分提供的所有类/接口(interface)也包含在我们的主要产品中,因此API开发人员不需要将我们的APISDKjar包含到他们的插件jar中。因此,我不担心APISDKjar的大小。但是,我想让插件开发人员的生活更轻松,只提供一个包含编译类和javadoc的jar文件(这样开发人员可以在开发时将内联注释视为自动完成功能的一部分)。我们使用Maven编译,我在APISDKpom.xml中添加了如下配置:org.apache.maven.pl