Questions tagged «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 …

863 java  hyperlink  javadoc 

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

768 java  url  javadoc  hyperlink 

我有一个小的代码示例，我想在方法的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 …

531 java  html  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) {...}

313 java  arguments  javadoc 

自从我使用Maven以来，我已经能够在本地存储库中构建并安装具有不完整Javadoc标记（例如，缺少参数）的项目。 但是，由于我迁移到Java 8（1.8.0-ea-b90），因此Maven对缺少文档标签的要求绝对严格，并在尝试构建或安装Javadoc不在其中的项目时向我展示许多与Javadoc问题有关的Javadoc错误。 “完善”。我试图编译并安装在本地存储库中的某些项目是我无法控制的第三方项目。因此，在我的情况下，仅修复所有这些项目中的所有Javadocs的变通办法似乎不可行。 这是我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] …

312 java  maven  migration  java-8  javadoc 

用于Eclipse的ADT r17插件的新版本增加了自动设置JAR依赖项的功能。/ libs文件夹中的所有.jar文件现在都已添加到构建配置中。不幸的是，Android Dependencies类路径容器是不可修改的。 如何将javadoc和源附加到自动插入的.jar（从/ libs文件夹）？

254 android  eclipse  adt  javadoc 

目前，我正在使用此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表，用于wold的字符123和64分别表示{和@，因此，根据文档，当此语法正确时，为什么这些字符无效？

238 java  javadoc 

尝试创建包级Javadoc注释时，首选方法是什么？你是做什么？ 包信息.java 优点 较新的 缺点 滥用类-类仅用于代码，而不仅仅是注释 package.html 优点 HTML扩展名表示其不是代码 IDE /文本编辑器中的语法突出显示 缺点 没有？ 对于我来说，我一直使用Package.html。但是我想知道它是否是正确的选择。

230 java  javadoc 

我可以在Android Studio中使用快捷键来生成Javadoc注释吗？ 如果没有，生成Javadoc注释的最简单方法是什么？

204 android-studio  javadoc 

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

190 java  comments  javadoc 

有人可以告诉我javadoc @see和之间的区别{@link}吗？ 或更确切地说，什么时候使用它们中的哪一个？

184 java  javadoc 

我知道这不是最重要的问题，但是我刚刚意识到我可以将Javadoc注释块放在注释之前或之后。我们想采用什么作为编码标准？ /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass other; }

183 java  coding-style  annotations  javadoc  code-documentation 

在Java API中，我可以看到软件包的Javadoc注释。 如何/在何处放置Javadoc注释来记录软件包？

182 java  packages  javadoc 

如何@在javadoc中转义符号？我正在尝试在{@code}标签内使用它<pre>。 我已经尝试了html转义@序列，但是没有用。

180 java  escaping  javadoc 

我正在使用Maven（和Maven Eclipse集成）来管理Eclipse中Java项目的依赖关系。从Maven存储库自动下载JAR文件的功能可以节省时间。不幸的是，它不包括API文档和源代码。 如何设置Maven以自动获取源文件和javadoc附件并在Eclipse中正确注册它们？

176 eclipse  maven-2  javadoc