Tag: javadoc

Maven站点（Maven 3）生成空站点文件夹: 我正在尝试使用maven网站插件创建一个基本的maven网站。所以我把它添加到我的pom： org.apache.maven.plugins maven-javadoc-plugin 2.7 Leon Blakey ${project.version} http://download.oracle.com/javase/6/docs/api 并运行mvn site –errors [INFO] Error stacktraces are turned on. [INFO] Scanning for projects… [INFO] [INFO] ———————————————————————— [INFO] Building pircbotx 1.3-SNAPSHOT [INFO] ———————————————————————— [INFO] [INFO] — maven-site-plugin:2.0.1:site (default-site) @ pircbotx — [INFO] ———————————————————————— [INFO] BUILD SUCCESS [INFO] ———————————————————————— [INFO] Total time: 2.688s [INFO] Finished at: Wed Jan […]

Javadoc使用相对路径链接到src / main / resource或src / test / resource文件: 如果有一种方法可以将javadoc中的链接放入驻留在src / main / resources或src / test / resources中的标准资源文件，以便其他编码器可以快速导航到资源文件（在此case一个JSON文件）。这些文件用于unit testing，需要在架构更改时经常进行修改。这里的答案链接到Javadoc中的文本文件（资源）没有帮助，因为绝对路径太脆弱了。有没有办法和@see一样做资源？如果javadoc本身不足，那么IntelliJ特有的东西会很棒。

在javadoc中，标签@throws和@exception之间有什么区别？: 以下面的基于数组的字符堆栈的实现为例： public char peek() throws Underflow { if (!isEmpty()) { return stack[pos]; } else { throw new Underflow(“Peeking at an empty stack.”); } } 回到我只使用文本编辑器时，我总是使用@exception标签，但现在我的IDE（Netbeans）在生成javadoc时使用了@throws。所以我的问题是，两者之间有什么区别，什么时候应该优先于另一个（例如使用上面的代码）？

我应该使用“非Javadoc”评论吗？: 我实现了自己在接口中定义的方法。但是，当我尝试将Javadoc添加到此方法时，Eclipse给了我这样的注释： /* (non-Javadoc) * @see javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent) */ 实际上，我真的需要为这个方法添加一些注释。我该怎么办？

关于java api doc的“字段摘要”: 当我阅读Java的API文档时，我看到一个名为“Field Summary”的字段。这部分用于什么？在这个领域中常量和类的用途是什么？谢谢。

如何在基于NetBeans的项目中将javaDoc添加到我的Java代码中？: 如何将JavaDoc或其他文档添加到netbeans？我试着用这种方式： Tools >> Java Platform >> JavaDoc Tab >> JavaDoc.zip (in my desktop) 但在编辑器中，当我在tooltiptext中按Ctrl + Space时，显示以下消息：找不到Javadoc。此项目的Javadoc文档不存在，或者您尚未在Java Platform Manager或库管理器中添加指定的Javadoc。我尝试重新启动NetBeans，但结果如下：

如何快速创建Eclipse中元素的Javadoc链接？: 我想从我的Javadocs中轻松创建类，方法，字段等的链接，而不必输入完整的表达式，例如{@link AllowAllHostnameVerifier} 。在Eclipse中执行此操作的最快方法是什么？

Javadoc =>如何添加一个很酷的标题标签: 我尝试在我的javadocs上添加这种类型的标题部分，我没有以简单有用的方式做到这一点。我能做到的唯一方法是使用HTML，我不认为HTML应该在代码中占有一席之地。这是我制作的javadoc的一个例子。我希望我的javadoc看起来与机器人完全一样，所以我希望添加标有红色方块的标题部分，而不是HTML。

如何根据Eclipse中的字段注释自动为getter / setter生成注释？: 我希望Eclipse根据先前为字段定义的注释自动为我的getter和setter方法生成Javadoc注释。我怎样才能做到这一点？背景：我们公司的一项政策是评论每个方法和领域（即使它们具有不言自明的名称）。因此，我必须通过描述字段并再次描述getter / setter来完成冗余工作。例： /** * name of the dynamic strategy */ private String dynName; /** * get the name of the dynamic strategy * @return */ public String getDynName() { return dynName; } 搜索网络显示我不是唯一一个有问题的人 – 但我找不到任何解决方案。我检查了http://jautodoc.sourceforge.net/，但似乎无法做到这一点。

为什么Javadoc生成不兼容的XHTML？: 我只是将一些生成的javadoc粘贴到eclipse项目中，发现没有一个HTML符合。甚至有些关闭标签从未打开的情况。有办法解决这个问题吗？也许是一个“合规”的选择……