标签: 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, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
 * @return baz
 */
public Baz fooBarBaz()

但我不知道如何@link正确格式化标签.

就像是:

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

我有一个小代码示例,我想包含在方法的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: looping through List of Map objects -- 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")); } 
Parameters
query …

我刚刚从Eclipse切换到IntelliJ并缺少Eclipse的一个功能 - 当你将鼠标放在方法上时它会显示一个javadoc信息.我发现(可能是我错了)显示的方式是快捷方式command+ J.当我点击它时出错了,请在下面的屏幕截图中看到.请告知我如何快速获取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)
{...}

由于我使用Maven,因此我能够在我的本地存储库项目中构建和安装具有不完整Javadoc标记的项目(例如,缺少参数).

但是,由于我迁移到Java 8(1.8.0-ea-b90),当我尝试构建或安装Javadoc不是Javadoc的项目时,Maven绝对严格缺少文档标记,并向我展示了许多与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 - /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:10: error: @param name not found
[ERROR] * @param terms the terms to assert
[ERROR] ^
[ERROR] /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:11: warning: no description for @return
[ERROR] * …

用于Eclipse的新版ADT r17插件添加了自动设置JAR依赖项的功能./ libs文件夹中的任何.jar文件现在都会添加到构建配置中.不幸的是,Android Dependencies类路径容器是不可修改的.

如何将javadoc和源附加到自动插入的.jar(来自/ libs文件夹)？

在尝试创建包级别的Javadoc注释时,首选方法是什么？你是做什么？

package-info.java

• 优点
  • 较新
• 缺点
  • 滥用类 - 类是代码,不仅仅是注释

package.html的

• 优点
  • HTML扩展意味着它不是代码
  • IDE /文本编辑器中的语法突出显示
• 缺点
  • 没有？

对我来说,我一直使用Package.html.但我想知道它是否是正确的选择.

目前我正在使用这种Javadoc语法引用其他类中的方法:

@see {@link com.my.package.Class#method()}

根据我从文档中的理解,这是正确的方法.但现在到了有趣的部分,还是令人沮丧.当我生成这个javadoc时,我首先得到以下错误:

warning - Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}"
warning - Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}"
warning - Tag @see: reference not found: {@link com.my.package.Class#method()}

生成的HTML代码是:

"," <code>com.my.package.Class#method()}</code> ","

当然,我没有联系.任何人都可以告诉我发生了什么,以及如何解决这个问题的任何提示？

根据ASCII表格,字符123和64代表{和@,那么根据文档,当这种语法正确时,为什么这些字符不能有效？

可能重复:
Javadoc模板生成器

有没有办法在Eclipse中生成Javadoc注释？如果是这样,它是什么？