Tag: javadoc

Javadoc:package.html或package-info.java

当试图创build包级Javadoc评论时,最好的方法是什么? 你是做什么? package-info.java 优点 较新 缺点 滥用类 – 类是为代码,而不是只有评论 package.html的 优点 HTML扩展意味着它不是代码 在IDE的/文本编辑器中的语法突出显示 缺点 没有? 对于我来说,我一直使用Package.html。 但我想知道如果它是正确的select。

如何在javadoc中添加对方法参数的引用?

有没有办法从方法文档体中添加对一个或多个方法参数的引用? 就像是: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String a, int b) {…}

当Javadoc标签不完整时,Maven不能在Java 8中工作

由于我使用Maven,我已经能够构build和安装在我的本地存储库项目,具有不完整的Javadoc标签(例如,一个缺less的参数)。 然而,自从我迁移到Java 8(1.8.0-ea-b90)以来,Maven对于缺失的文档标签是绝对严格的,并且在尝试构build或安装Javadoc不是Javadoc的项目时,显示出大量有关Javadoc问题的Javadoc错误“完善”。 我试图编译并安装在本地存储库中的一些项目是我无法控制的第三方项目。 所以,在所有这些项目中修复所有Javadoc的解决方法在我的场景中似乎不是可行的。 这是我在我的项目中执行mvn clean package install时输出的一小部分: [INFO] ———————————————————————— [INFO] BUILD FAILURE [INFO] ———————————————————————— [INFO] Total time: 9.026s [INFO] Finished at: Mon Apr 08 21:06:17 CEST 2013 [INFO] Final Memory: 27M/437M [INFO] ———————————————————————— [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project jpc: MavenReportException: Error while creating archive: [ERROR] Exit code: 1 – […]

如何在IntelliJ IDEA中看到JavaDoc?

我只是从Eclipse切换到IntelliJ,并没有从Eclipse的function – 当你把鼠标放在一个方法,它显示一个javadoc信息。 我发现(可能是我错了)显示的方式是一个快捷键command + J 当我点击它时,我得到了一些错误,请看下面的屏幕截图。 请build议如何快速获取javadoc信息。 我至less需要知道什么types的方法返回。

Javadoc注释中的多行代码示例

我想在一个方法的Javadoc注释中包含一个小代码示例。 /** * — ex: looping through List of Map objects — * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); * } * </code> * * @param query – select statement * @return List of Map objects */ 问题是在Javadoc中显示的代码示例中没有换行符使其难以阅读。 — ex: […]

如何在javadoc中引用一个方法?

如何使用@link标签链接到一个方法? 我想改变 /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() 至 /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, […]

链接到Javadoc中的外部URL?

就像是: /** * See {@linktourl http://google.com} */

/ **和/ *在Java注释中

有什么区别 /** * comment * * */ 和 /* * * comment * */ 在Java中? 我应该什么时候使用它们?

Eclipse中的Javadoc无法识别包

感谢这个线程 ,我能够获得Javadoc链接,以在Windows上的Eclipse中为我的Android项目工作。 具体来说,“{@link android.widget.Toast}”目前转换为“ http://d.android.com/reference/android/widget/Toast.html?is-external=true ”的链接。 我用Javadoc选项实现了这一点: -linkoffline http://d.android.com/reference“file:/ C:/ Android / android-sdk-windows / docs / reference” 但是,根据我的Java代码(不是J​​avadoc注释),我得到以下错误: C:\ Users \用户埃伦\工作空间\ TestableToast \ SRC \ EDU \钢厂\ cs180 \ HelloAndroid.java:5: 包android.view不存在 导入android.view.View; ^ C:\ Users \用户埃伦\工作空间\ TestableToast \ SRC \ EDU \钢厂\ cs180 \ HelloAndroid.java:6: 包android.view.View不存在 导入android.view.View.OnClickListener; ^ C:\ Users \用户埃伦\工作空间\ TestableToast \ SRC \ […]

如何在Eclipse中生成Javadoc HTML?

我在我的项目中写了这样的Javadoc风格的评论: /** * Description… * * @param … * @return ….. */ 如何从Eclipse生成Javadoc HTML?