javadoc相关内容

Javadoc 模板生成器

我有一个没有 Javadoc 的大型代码库，我想运行一个程序来编写带有基本 Javadoc 信息的骨架(例如，为每个方法的参数写入 @param...)，所以我只需要填补空白离开了. 有谁知道解决这个问题的好方法吗? 编辑: JAutodoc 正是我想要的.它有 Ant 任务、一个 Eclipse 插件，并使用 Velocity 作为模板定义. 解决方案 Eclipse ..
发布时间：2021-11-22 17:06:34 Java开发

JavaDoc 中@see 的用法?

在处理 JavaDocs 时我什么时候使用 @see?它的用途是什么? 例如，如果 MethodA 调用 MethodB 那么我是否必须将 @see 放在 MethodB 的 javadoc 中并引用 MethodA 因为那是调用它的原因，还是我必须从 MethodA 引用 MethodB 因为它正在调用它.我在 Oracle 网站上阅读了有关 @see 的内容，在我看来它非常含糊，它说它的 ..
发布时间：2021-11-22 17:06:26 Java开发

是否有用于记录泛型类型参数的 javadoc 标签?

我一直在查看 Sun 站点上的 javadoc 文档，试图找出是否有一个 javadoc 标记可用于记录类或方法的通用类型签名. 类似于@typeparam，类似于通常的@param，但适用于类型和方法，例如 /*** @typeparam T 这描述了我的类型参数*/class MyClass{} 我怀疑没有这样的标签 - 我在任何地方都找不到它的提及，JavaSE API 文档也没有 ..
发布时间：2021-11-22 17:06:19 Java开发

Javadoc 有一些好的和现代的替代品吗?

让我们面对现实:你不需要成为设计师就能看到这一点默认Javadoc 看起来很丑. 网络上有一些资源提供重新设计的 Javadoc.但默认行为代表产品，应该看起来相当漂亮. 另一个问题是，与其他类似资源相比，Javadoc 的可用性不是最新的. 使用 Firefox 的快速搜索很难浏览大型项目. 实际问题: 是否有任何能够浏览的独立(桌面)应用程序以比浏览器更有用的方式现有 ..
发布时间：2021-11-22 17:06:09 Java开发

代码风格；将 javadoc 放在注释之前还是之后?

我知道这不是最重要的问题，但我刚刚意识到我可以在注释之前或之后放置 javadoc 注释块.我们希望采用什么作为编码标准? /*** 这是注解前的 javadoc 注释*/@成分公共类 MyClass {@自动连线/*** 这是注解后的javadoc注释*/私人 MyOtherClass 其他；} 解决方案 在注解之前，因为注解是“属于"类的代码.请参阅官方文档中的javadoc 示例. ..
发布时间：2021-11-22 17:06:00 Java开发

javadoc 自定义标签

我已经在谷歌上搜索了将近一个小时，但找不到任何关于制作自定义标签的好信息.当我检查 javadoc 的帮助时，它说的是关于自定义标签... -标签 :: 它没有定义任何事物是什么.我认为 name 将是标签的名称，标题可能是您生成 javadoc 时标签所说的内容，但什么是位置以及如何使用它? 名称、位置和标题也需要用引号引起来吗? 一些自定义标签示例以及对位置的解释可能对 ..
发布时间：2021-11-22 17:05:42 Java Web开发

用于匹配 javadoc 片段的正则表达式

这个问题让我想到了正则表达式进行匹配javadoc 包含一些指定文本的注释. 例如，查找包含 @deprecated 的所有 javadoc 片段: /*** 方法一* .....* @已弃用* @返回*/ 我设法得到表达式 /\*\*.*?@deprecated.*?\*/ 但在某些情况下会失败，例如: /*** 方法一* .....* @返回*/公共 int Method1() { ..
发布时间：2021-11-22 17:05:32 Java开发

如何创建多语言 JavaDocs?

有英文版和中文版的普通Java API的JavaDoc，但似乎每个版本都需要单独的源代码.有没有更方便的方法来做到这一点? 解决方案 不，基本上没有办法做到这一点. 想到的唯一解决方法适用于生成的 HTML 页面:您可以将 JavaDocs 包围在块元素中，这些元素使用 CSS 在语言之间切换.考虑: /*** 英文文档* ..
发布时间：2021-11-22 17:05:21 Java开发

Eclipse Android 项目中的 JavaDoc

在我们的 Android 项目中，我们的代码是 JavaDoc 的，可以正确生成所有内容.但是，对 Android API 类/函数的任何引用都会导致 JavaDoc 错误，并且不会生成指向相关信息的链接.相反，我们得到纯文本的类名.我们如何设置 Eclipse 以将这些转换为指向在线 Android API 参考(最好)或本地副本(如有必要)的链接? 解决方案 如果您有“Android ..
发布时间：2021-11-22 17:05:12 Java开发

如何在 Eclipse 中为 Servlet API 添加 Javadoc

我在 Eclipse 中有一个动态 Web 应用程序，它使用 Tomcat 作为运行时环境. 我无法添加 Javadoc 路径 Tomcat Servlet API:如图所示，编辑按钮始终处于禁用状态！ 替代文字 http://filaty.com/i/1005/80306/tom.JPG 解决方案 在项目的包资源管理器中，转到 Java 资源 > 库.右键单击 servlet ..
发布时间：2021-11-22 17:05:03 Java开发

是否应该将 Javadoc 注释添加到实现中?

在界面中添加Javadoc注释并在实现中添加非Javadoc注释是否正确做法? 当您自动生成注释时，大多数 IDE 会为实现生成非 JavaDoc 注释.具体方法不应该有说明吗? 解决方案 对于仅用于实现(而不是覆盖)的方法，当然，为什么不呢，尤其是如果它们是公共的. 如果您有一个压倒一切的情况并且您要复制任何文本，那么绝对不会.复制是导致差异的万无一失的方式.因此，用户会根据 ..
发布时间：2021-11-22 17:04:53 Java开发

如何更改 Eclipse 中生成的 Javadocs 模板?

我不喜欢在创建类或方法时为我生成的默认 Javadoc，尤其是 @author 变量，它是我的 windows 框上的当前系统用户名. 我想改变它.这可能吗? 解决方案 检查 Preferences/Java/Code Style/Code Template 部分注释/类型 你可以用你需要的任何值替换 author 标签，它会对新生成的类产生影响. 但是，如果模板很 ..
发布时间：2021-11-22 17:04:32 Java开发

在 Intellij IDEA 中附加额外的 javadoc

当我对 j2ee 类或 IDEA 中的注释使用快速文档查找 (Ctrl+Q) 时，我只得到一个空的 javadoc.它只包含类名等基础知识. 如何将 javadoc 添加到 IDEA 提供的库中? 解决方案 您可以将 javadoc 附加到您在模块或项目中配置的任何库.只需访问项目结构窗口(File -> Project Structure)，然后选择“模块"并选择具有您要配置的依赖 ..
发布时间：2021-11-22 17:04:21 Java开发

如何在 Android Studio 中生成 javadoc 注释

我可以在Android studio中使用快捷键生成javadoc注释吗? 如果没有，生成 javadoc 注释的最简单方法是什么? 解决方案 我找不到任何生成 javadoc 注释的快捷方式.但是如果在方法声明前输入/**并回车，javadoc注释块会自动生成. 阅读此了解更多信息. ..
发布时间：2021-11-22 17:04:14 Java Web开发

如何在 Java 中记录包?

在 Java API 中，我可以看到包的 Javadoc 注释. 如何/在哪里放置 Javadoc 注释来记录包? 解决方案 从 1.5 开始，您可以定义 package-info.java 文件并为包提供标准的 javadoc 样式注释: com/foo/package-info.java: /*** com.foo 是一组用于操作 foo 事物的 bar 实用程序.*/包 c ..
发布时间：2021-11-22 17:03:54 Java开发

简单的 Getter/Setter 注释

您使用什么约定来评论 getter 和 setter?这是我想了很长时间的事情，例如: /*** (1a) 你在这里放了什么?* @param 薪水 (1b) 你把什么放在这里?*/public void setSalary(浮动工资);/** (2a) 你在这里放了什么?* @return (2b)*/公共浮动 getSalary(); 我总是发现我为 1a/b 和 2a/b 编写了完全相同 ..
发布时间：2021-11-22 17:03:45 Java开发