javadoc相关内容

Intellij 为方法和类生成 javadoc

是否可以将 Intellij 设置为使用 @author 和 @since date 自动生成方法和类的 javadoc? 我在 Eclipse 中有这个功能. 我知道,这些文件有模板,而且我可以手动半自动地将 javadoc 添加到选定的方法/类.但我希望为每个生成的方法/类/枚举/接口/字段等自动生成 这对于例如很有用“提取方法"、“覆盖/实现"、“创建 getter/setter"等 ..
发布时间:2021-11-22 17:09:57 Java开发

javadoc:@version 和@since

是否有理由将 @version 和 @since 作为类的一部分包含在内? 它们似乎是相互排斥的. 另外,%I% 和 %G% 是什么意思,如何设置/使用它们? @version %I%, %G% 解决方案 @version 标签应该是相关发行版或文件的当前版本.%I%、%G% 语法是源代码控制软件将替换为文件的当前版本和文件签出日期的宏. @since 标签应该用于定义你 ..
发布时间:2021-11-22 17:09:40 Java开发

Android Studio:悬停时 Javadoc 为空

我最近从 Eclipse 转移到了 Android Studio,并且很喜欢它.但是,我想念 Eclipse 的悬停功能的 Javadoc. 我按照此处的说明添加功能,但是,我的悬停不包含 Javadoc.如果我使用文档快捷方式 Ctrl + Shift + Space 它将正确显示文档,但是,我真的希望它出现在工具提示. 下面是我看到的截图.很明显,这个方法应该有一个 Javadoc ..
发布时间:2021-11-22 17:09:31 移动开发

有什么方法可以在 Eclipse 中自动生成所有 Javadoc 注释?

我知道你可以按 shift+alt+j 为当前代码块插入一个合适的注释模板,但是有没有什么办法让 eclipse 发疯并像这样做一个完整的项目? 解决方案 对于整个项目,可能不是,但你至少可以: 转到包资源管理器视图 展开你想要生成评论的类(打开每个方法) 从包资源管理器树中选择类中所有打开的元素 alt+shift+J 和瞧:在类和每个方法上生成的注释 不适合所有项目的 ..
发布时间:2021-11-22 17:09:23 Java开发

Netbeans:如何更改@author

在 Netbeans IDE 中创建新类或接口时,会出现“@author ...."标记.如何改变它的价值?如果可能,我想通过使用 Netbeans 菜单而不是通过编辑一些配置文件来更改它:) 我使用的是 Netbeans 7.2 解决方案 步骤: 转到工具 -> 模板. 点击设置按钮.IDE 中将出现一个带有模板设置的新面板: 取消对最后一行的注释并将“user"的值更 ..
发布时间:2021-11-22 17:09:14 Java Web开发

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

有没有办法从方法文档正文中添加对一个或多个方法参数的引用?类似的东西: /*** 当 {@paramref a} 为空时,我们依赖 b 进行解调.** @param a 这是参数之一* @param b 另一个参数*/void foo(String a, int b){...} 解决方案 据我所知 javadoc 的文档 没有这样的功能. 不要像其他答案中推荐的那样使用 foo;你可以 ..
发布时间:2021-11-22 17:09:05 Java开发

Javadoc 的好例子

是否有一个很好的源文件示例,其中包含Javadoc? 我可以在互联网上找到很多很好的 Javadoc 示例,我只想找出用于创建它们的特定语法,并假设我可以在某处仔细阅读某个库的源代码,但这似乎很多工作. 解决方案 JDK 源代码怎么样,但是通过像 docjar 这样的 3rd 方访问?例如,集合源. 这样,就没有大的下载. ..
发布时间:2021-11-22 17:08:56 Java开发

当android库具有也是aar库的依赖项时,如何为它生成javadoc?

我有一个 android 库项目,它依赖于其他 android 库项目.我需要为库生成 javadoc,但它失败了,因为 gradle 将 javadoc 类路径放在 .aar 位置,但 javadoc 需要 .jar 文件. 简化的gradle文件: android {compileSdkVersion 23构建工具版本“23.0.2"配置{文档}默认配置{minSdk 版本 7目标SD ..

是否“/*(非 javadoc)"有一个很好理解的意思吗?

/* (non-javadoc) 除了向源代码的读者指出注释块故意不是 Javadoc 注释之外,是否还有意义?最近我看到很多这样的代码: /**(非javadoc)** 此方法将小部件转换为小玩意*/公共 Foo bar() {... 这是某种既定的惯例吗?如果是,它是什么意思(超出明显的字面意思)以及何时使用? 解决方案 根据 我能找到的信息,这是为了修复旧版本的 JavaDoc ..
发布时间:2021-11-22 17:08:40 Java开发

Javadocs 链接到外部 javadoc

我正在生成 Javadoc.现在我想自动将所有库和 JDK 类链接到该库或 JDK 的官方文档.这可能吗,如果可以,我需要哪些命令行参数 解决方案 解析对标准 Java 类的引用要求您拥有 Java 文档的本地副本. JDK 7 JavaDocs 可在此处在附加下获得资源 然后,使用 -link 选项运行 javadoc.它需要您要引用的文档的 URL(例如,https://d ..
发布时间:2021-11-22 17:08:29 Java开发

是否有记录 GET/POST 参数的标准?

在一个 PHP 项目中,即使主应用程序使用前端控制器逻辑,也可能有很多独立的脚本、ajax 片段等. 是否有一种标准化的方式 - PHPDoc 或其他方式 - 在脚本的第一个注释块中定义脚本将接受/需要哪些 GET 和/或 POST 参数以及它们是哪种类型? 我通常通过添加 @param 来帮助自己,就好像文件是一个函数一样,以及一个 @return 解释脚本的作用和返回,但也许还有一 ..
发布时间:2021-11-22 17:08:20 PHP

生成本地化的 javadoc

我想知道是否有一种生成本地化 javadoc 的简单方法:我想在 html 中翻译(例如法语)标题和关键字,而不是“返回"、“参数"、“类". 解决方案 正如 Matt Ball 所说,你可以向 javadoc 提供 -locale 选项来影响一些事情.问题是tools.jar只包含默认的英文和另外一个日文(ja)和一个中文(cn_ZH)翻译. 我刚刚试过中文的,它有效:它写抛出:J ..
发布时间:2021-11-22 17:08:12 Java Web开发

Java Javadoc 包括 Private

我想为我的应用程序生成 javadoc,我还想包含私有成员. 我在 Javadoc 文档中找到了以下内容 -私有显示所有类和成员. 你能帮我举个例子吗? 它应该类似于:javadoc -private ....我需要知道如何为生成的 html doc 文件提供根目录和目标目录. 谢谢. 编辑:我找到了一种从 NetBeans 6.8 生成 javadoc 的方法.如 ..
发布时间:2021-11-22 17:08:02 Java开发

Netbeans 说找不到 javadocs

我在使用 Netbeans IDE 时遇到了一些问题.我安装了 v.7.0.1,但是现在javadoc的弹出窗口说: 未找到 Javadoc.此项目的 Javadoc 文档不存在或您尚未在 Java 平台管理器或库中添加指定的 Javadoc经理. 为什么不自动下载 JavaDocs?我说的是 Java Platform SE 的组件、方法等. 解决方案 转到工具 -> Java 平台 ..
发布时间:2021-11-22 17:07:42 Java Web开发

File.mkdir 或 mkdirs 返回 false - 原因?

为什么 file.mkdir 返回 false? Google 表示可能有多种原因(例如安全性、权限、路径名等). 我的问题: 如何找到返回false的确切原因? 如果安全/权限是一个原因,那么为什么不抛出 SecurityException? 解决方案 如果安全/权限是一个原因,那么为什么不抛出 SecurityException(在 javadoc 中提到)? ..
发布时间:2021-11-22 17:07:23 Java开发

如何通过反射阅读 Javadoc 注释?

我需要知道如何在运行时阅读 Javadoc 注释(可能通过反射?) 假设我有以下功能: /*** 做某事的函数*/公共无效 myFunc(){//...} 在运行时,我可以通过反射获得有关此函数的很多信息..但无法阅读评论.所以问题是,如何在运行时阅读这个 javadoc 注释. 解决方案 考虑使用注解代替 Javadoc 并编写注解处理器. ..
发布时间:2021-11-22 17:07:13 Java开发

删除 JavaDoc 注释的工具?

是否有任何工具/Eclipse 插件可以删除文件中的所有 JavaDoc 注释? 运行该工具后,正常(非 JavaDoc)注释应该是完整的. 解决方案 试试这个正则表达式在 eclipse/sed/你最喜欢的支持正则表达式的编辑器中搜索替换. /\*\*(?s:(?!\*/).)*\*/ ?s 将输入视为单行 一个起始字符串\** 零个或多个 */的负前瞻 空格或非空格字 ..
发布时间:2021-11-22 17:07:02 Java开发