javadoc相关内容

如何为 Android 支持库启用 javadoc?

当为了兼容性而使用 Android 支持库并尝试查看 javadoc 时,例如 FragmentTransaction,我收到以下错误,因为没有关联的 javadoc 文件: android.support.v4.app.FragmentTransaction 注意:这个元素既没有附加源也没有附加Javadoc因此找不到 Javadoc. 在项目属性中的Android Depen ..
发布时间:2021-11-22 17:03:25 移动开发

Javadoc @author 标记良好实践

我想知道创建 Javadoc 时的最佳实践.我有一个包含许多文件的项目.许多开发人员已经创建了代码.每个文件都有一个注释@author,所以很明显是谁创建了一个特定的类. 但是当其他一些开发人员向文件添加新代码、修改它等时,他应该如何通知团队的其他成员他已经创建了一些新功能或修改了现有代码?换句话说,我们应该如何“保持 Javadoc 与现实兼容"?;) 将他的名字添加到现有的 @au ..
发布时间:2021-11-22 17:03:16 Java开发

delphi 的代码文档类似于 javadoc 或 c# xml doc

我需要一个类似于用于 delphi 代码的 javadoc 或 c# xml doc 的代码文档工具.最好的工具是什么?我更喜欢一种技术,它在未来兼容微软的沙堡项目. 解决方案 看一看 SynProject,一个用 Delphi 编写的开源工具. 它旨在处理完整的文档工作流程,从规范到发行说明,包括测试、架构和设计;当然,还有一个集成的 Delphi 解析器,可以从现有的 Delph ..
发布时间:2021-11-22 17:03:07 Java Web开发

如何从命令行生成 Javadoc

谁能告诉我如何从命令行生成 Javadoc? 我的项目包含包 com.test,我想将生成的文档放在位于特定文件夹中的文件中,如下所示:C:/javadoc/test. 解决方案 可以参考javadoc 8 文档 我认为你正在看的东西是这样的: javadoc -d C:\javadoc\test com.test ..
发布时间:2021-11-22 17:02:45 Java开发

你怎么能转义javadoc中的@字符?

如何转义 javadoc 中的 @ 符号?我试图在 {@code} 标签中使用它,该标签位于 标签内. 我已经尝试过 html 转义 @ 序列,但是没有用. 解决方案 使用 {@literal} javadoc 标签: /*** 这是一个“at"符号:{@literal @}*/ 此 javadoc 将显示为: 这是一个“at"符号:@ 当然,这适用于任何 ..
发布时间:2021-11-22 17:02:23 Java开发

Javadoc:package.html 或 package-info.java

尝试创建包级 Javadoc 注释时,首选方法是什么?你是做什么的? package-info.java 优点 较新 缺点 滥用类 - 类用于代码,而不仅仅是用于注释 package.html 优点 HTML 扩展意味着它不是代码 IDE/文本编辑器中的语法高亮 缺点 没有? 对我来说,我一直使用 Package.html.但我想知道它是否是正确 ..
发布时间:2021-11-22 17:02:12 Java开发

如何从 javadoc Ant 任务的结果中排除特定的方法/构造函数?

我正在使用由 javadoc Ant 任务生成的 javadoc 来记录 Web 服务,并且我想从输出中排除一些构造函数.我该怎么做? 解决方案 对于公共方法没有办法做到这一点.标准做法(即使在相当多的 JDK 类中)是表明该方法或构造函数不适合公共使用. 有一个 计划添加@exclude 标签未来: @exclude - 用于排除的 API由 Javadoc 生成.程序员将标 ..
发布时间:2021-11-22 17:02:02 Java开发

如何创建自定义 javadoc 标签?

如何创建自定义的 javadoc 标签,例如 @pre/@post?我找到了一些解释它的链接,但我没有运气.这些是一些链接: http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html http://java.sun.com/j2se/1.5.0/docs/tooldocs/windo ..
发布时间:2021-11-22 17:01:54 Java开发

如何使生成的类包含 XML Schema 文档中的 Javadoc

我目前正在使用一个 XML 模式,该模式在大多数类型和元素上具有 /.当我从这个 XML Schema 生成 Java Bean 时,这些 Bean 的 Javadoc 只包含一些关于类型/元素的允许内容的通用生成信息. 我想在相关位置看到 标签的内容(例如,complextType 标签的内容应该显示在生成的类来表示那个 complexType). ..
发布时间:2021-11-22 17:01:43 Java开发

重载方法的 Javadoc 重用

我正在开发一个 API,其中包含许多同名方法,只是签名不同,我猜这很常见.它们都做同样的事情,只是如果用户不想指定,它们会默认初始化各种值.作为一个易于理解的例子,考虑 公共接口森林{公共树 addTree();公共树 addTree(int amountOfLeaves);public Tree addTree(int amountOfLeaves, FruitfruitType);publi ..
发布时间:2021-11-22 17:01:34 Java开发

如何在 IntelliJ IDEA 中查看 JDK 外部文档?

此操作的快捷方式是 Shift+F1,但即使我已将 JDK documentation path 指向 docs 文件夹(从jdk-7u2-apidocs.zip). 谢谢 解决方案 需要指定解压文档的docs/api子目录或使用https://docs.oracle.com/javase/8/docs/api/ 外部文档功能的 URL. 文件 ->项目结构... 然后在这里: ..
发布时间:2021-11-22 17:01:24 Java Web开发

如何将 Java API 文档添加到 Eclipse?

我已经从 http://www 下载了 Java API 文档.oracle.com/technetwork/java/javase/downloads/index.html#docs 并据称使用 将其附加到 Eclipse Window->Preferences->Java->InstalledJREs->编辑->“选择rt.jar"->Javadoc位置 并且该位置已被接受并“验证" ..
发布时间:2021-11-22 17:01:12 Java开发

如何下载Javadoc离线阅读?

我只知道如何在网站上在线阅读 Javadoc,但我想在没有网络的情况下下载以供离线阅读. 我指的是 Java® Platform, Standard Edition &Java 开发工具包版本 x API 规范. 如何下​​载文档? 解决方案 JDK 文档链接 Java SE下载网页其他 18(抢先体验) 暂不可用 Javadoc 抢先体验页面 17 (LTS) 下载 ..
发布时间:2021-11-22 17:01:06 Java Web开发

将 javadoc 用于 Python 文档

我目前开始使用 Python,我有很强的 PHP 背景,并且在 PHP 中我养成了使用 javadoc 作为文档模板的习惯. 我想知道 javadoc 在 Python 中是否有其作为 docstring 文档的位置.这里有哪些既定的惯例和/或官方准则? 例如像这样的东西是否过于复杂而无法适应 Python 的思维方式,还是我应该尽量简洁? """用值替换模板占位符@param st ..
发布时间:2021-11-22 17:00:58 Python

如何引用“*/"在 JavaDocs 中

我需要在我的 JavaDoc 注释中包含 */.问题是这也是关闭评论的相同顺序.引用/转义这个的正确方法是什么? 示例: /*** 如果指定的字符串包含“*/",则返回 true.*/public boolean containsSpecialSequence(String str) 跟进:看来我可以使用 / 作为斜线.唯一的缺点是,直接在文本编辑器中查看代码时,这并不是那么易读 ..
发布时间:2021-11-22 17:00:51 Java开发

Java 注释中的/** 和/*

和 有什么区别 /*** 评论***/ 和 /*** 评论**/ 在Java中?我应该什么时候使用它们? 解决方案 第一种形式称为 Javadoc.当您为您的代码编写正式的 API 时,您可以使用它,这些 API 是由 javadoc 工具生成的.例如,Java 7 API 页面使用 Javadoc 并由该工具生成. 您会在 Javadoc 中看到的一些常见元素包括: ..
发布时间:2021-11-22 17:00:34 Java开发

如何在运行时获取方法的 JavaDoc?

在运行时获取Class的方法名很容易 但是 如何在运行时获取方法的 JavaDoc ? 如下例 包含目标方法的JavaDoc的类 public class MyClass {/**** @param x 值 ....* @return ...的结果*/公共字符串 myMethod(int x) {返回“任何值";}} 我们的类有一个 main 方法 公共类 TestJava ..
发布时间:2021-11-22 17:00:17 Java开发