documentation相关内容

Microsoft SkyDrive 是否有 API?

根据 最近的消息,Microsoft Skydrive 是每个帐户将获得 25GB 的存储空间,有谁知道 SkyDrive 是否有 API? (如果有,文档在哪里?) 解决方案 SkyDrive(重命名为“OneDrive")具有官方 API.可以通过转至 OneDrive 开发人员中心 找到详细信息. 您还可以在 在 GitHub 上找到使用 OneDrive API 的代码 ..
发布时间:2021-12-08 10:24:51 其他开发

熊猫重新采样文档

所以我完全理解如何使用 resample,但文档没有很好地解释选项. 所以 resample 函数中的大多数选项都非常简单,除了这两个: 规则:表示目标转换的偏移字符串或对象 how : 字符串,下采样或重采样的方法,默认为‘mean’ 所以通过查看我在网上找到的尽可能多的例子,我可以看到规则你可以做 'D' 一天,'xMin' 分钟,'xL' 毫秒,但这就是我能找到的. ..
发布时间:2021-12-03 08:59:18 Python

如何在 PhpDocumentor 中显示继承方法的完整文档块?

我目前有代码,其中有一个抽象父类定义了一些具体方法,子类扩展了这个父类,并将使用具体方法.例如: 在我的 child_class 文档中,我看到我的 bar() 函数有很好的文档记录,包括方法摘要和方法的详细描述...但是我继承的 foo() 函数仅声明为继承我需要点击一个链接来查看它的完整文档,甚至只是看到它可以被这个函数调用.我所看到的一个例子显示在图像这里中.(我是新用户,不能放图片. ..
发布时间:2021-11-25 09:16:21 C#

javadoc:@version 和@since

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

Javadocs 链接到外部 javadoc

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

Javadoc 模板生成器

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

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

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

一个添加和完善PHP源代码文档的工具

我已经完成了几个较旧的 PHP 项目,其中包含很多我想以 javadoc/phpDocumentor 样式记录的内容. 虽然手动处理每个文件并被迫在编写文档的同时进行代码审查将是最好的事情,但我只是因为时间限制,对帮助我尽可能自动化任务的工具感兴趣. 我正在考虑的工具最好具有以下功能: 解析一个 PHP 项目树并告诉我哪里有未记录的文件、类和函数/方法(即缺少适当的文档块注释的元 ..
发布时间:2021-11-22 17:02:34 Java Web开发

将 javadoc 用于 Python 文档

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

Android Studio 中没有参考文档

昨天刚出现一个新问题.当我将鼠标悬停在某个方法上或按 Ctrl-Q 时,我曾经获取过该特定方法的文档信息. 但现在我得到了(在 SharedPreferences.getLong() 上按 Ctrl-Q): 检查以下外部网址:http://developer.android.com/reference/android/content/SharedPreferences.html#getLo ..
发布时间:2021-11-21 20:47:24 Android

是否有一致的 UML 图样式来记录或说明(Docker)容器在系统架构规范中的作用?

我计划绘制一些 UML 结构图来说明 Docker 映像(或容器,在部署图中)在我正在构建的软件的整体结构中的位置.我对说明容器的内容、网络端口和其他接口的映射以及多个容器互操作的方式很感兴趣. 我的问题空间是分布式的、基于事件的系统 (DEBS),所以我预计我的大多数容器都会有消息队列进出.我的架构的另一部分涉及使用内存数据网格,它将跨越集群中多个节点的多个容器. 如何用 UML 建 ..
发布时间:2021-11-17 02:23:01 其他开发

用于创建 API 文档/提案的平台独立工具

有哪些工具可用于开发独立于平台的 API 文档? 我正在设计提议的 API,并希望以结构化且易于编辑的方式编写文档.我看到的很多答案基本上都是“使用特定于语言的内置文档工具",但是由于我是从“顶级"设计 API,而不是实现它,因此这不是很有用.我正在寻找 API 文档的 CMS 我已经看到一些使用 PBWiki 或 Confluence 的建议,但我不相信普通的 wiki 是最好的选择 ..
发布时间:2021-11-15 21:03:59 其他开发

有没有关于“感情"的文件?Facebook 状态中的功能?

我有一个 HTML 页面,您可以在其中通过任何 App ID 更新您的状态,我只是想知道他们最近添加的“感觉"功能是否有任何文档?我很想将该功能添加到我的页面中. 我在任何地方都找不到与此问题相关的任何内容,所以让我在这里提问. 解决方案 截至目前,第三方开发者无法使用表达情感的功能.它仍在向公众推出. 它建立在 Open Graph 操作(例如感觉)和对象(例如快乐)的基础上 ..
发布时间:2021-11-15 04:25:40 其他开发

有没有关于“感情"的文件?Facebook 状态中的功能?

我有一个 HTML 页面,您可以在其中通过任何 App ID 更新您的状态,我只是想知道他们最近添加的“感觉"功能是否有任何文档?我很想将该功能添加到我的页面中. 我在任何地方都找不到与此问题相关的任何内容,所以让我在这里提问. 解决方案 截至目前,第三方开发者无法使用表达情感的功能.它仍在向公众推出. 它建立在 Open Graph 操作(例如感觉)和对象(例如快乐)的基础上 ..
发布时间:2021-11-15 04:06:06 其他开发

用于创建 API 文档/提案的平台独立工具

有哪些工具可用于开发独立于平台的 API 文档? 我正在设计提议的 API,并希望以结构化且易于编辑的方式编写文档.我看到的很多答案基本上都是“使用特定于语言的内置文档工具",但是由于我是从“顶级"设计 API,而不是实现它,因此这不是很有用.我正在寻找 API 文档的 CMS 我已经看到一些使用 PBWiki 或 Confluence 的建议,但我不相信普通的 wiki 是最好的选择 ..
发布时间:2021-11-15 04:00:53 其他开发

他们在哪里隐藏了 DotNetOpenAuth API 文档?

我很确定我查看了最常见的地方,但似乎找不到 DotNetOpenAuth API 的文档.几乎每个链接都转发到 docs.dotnetopenauth.net,这似乎并不存在. 有谁知道他们把文档藏在哪里了?非常感谢:) 解决方案 取决于您使用的版本: http://docs.dotnetopenauth.net/v4.0/ http://docs.dotnetopenaut ..
发布时间:2021-11-15 03:52:05 其他开发

如何解析一个javadoc?

我正在使用 Java 阅读 javadocs. 我的java对象有属性,描述包裹名字方法名称、方法描述 是否有任何现有的 api 可以做到这一点?如何以提取上述属性的方式读取 javadoc? 解决方案 javadoc 工具包括用于编写自定义 doclet 的 API.这些基本上获得了文档片段的解析树,并基于此生成某种报告.标准 doclet 生成每个人都熟悉的 HTML 页面 ..
发布时间:2021-11-15 03:30:58 其他开发

生成 REST API 文档的最佳方法是什么?

我正在寻找一种为 REST API 生成文档的好方法.它不需要实际连接代码或任何东西,但是能够将文档编写为文本文件,将工具指向它并从中生成一些文档,这真是太棒了. 有人有什么想法吗?我知道我有点含糊,但老实说,我不太确定我在这里寻找什么——主要是一种管理文档的简单方法. 解决方案 据罗伊说: "一个 REST API 应该花费几乎所有的描述性努力定义用于表示的媒体类型资源和驱动应用 ..
发布时间:2021-11-15 03:30:26 其他开发

无法访问 Maximo API 的文档?

我不是 100% 确定这个话题是否“离题";但我找不到更适合我的问题的堆栈交换. 我正在使用 Maximo API 并定期使用 IBM 文档来帮助我编程.2 天前,我仍然可以访问文档,例如: 这让我大致了解了类、字段、方法等. 今天我尝试访问以下文档: 但出现以下消息: 现在,我无法相信他们已经删除了所有文档,所以我认为他们可能已经移动了它们,但我就是找不到它们.我在 ..
发布时间:2021-11-15 03:05:45 其他开发

如何共享 Swagger 文档

我最近开始在我的文档中使用 Swagger,但我仍然不清楚一些事情.我创建了我的 YAML 文档,现在我希望能够与我团队的其他成员共享 .pdf 或 HTML/Javascript 页面中的文档.我无法使用 SwaggerHub,因为他们没有私有存储库,而且 Swagger 编辑器似乎不允许共享右侧的面板. 为了清楚起见,我希望能够得到类似的东西: 我错过了什么? 解决方案 D ..
发布时间:2021-11-15 02:40:44 其他开发