documentation

documentation

文章 0 浏览 6

通过 gem 的 API 文档

Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not …

琉璃梦幻 2024-12-28 09:52:31 0 0

如何使用 Roxygen2 添加类特定别名而不使用通用别名?

一个简单的例子是,我创建了 show 的扩展,它是 S4 基本方法。我不想通过在我的包中重新记录 show 来引起歧义分叉,并且我还想将我的扩展文档合并到 s…

Hello爱情风 2024-12-28 07:01:40 2 0

什么文档软件正在使用 Ruby on Rails 3.1?

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers. 这个问题似乎与帮助中心中定义的范围内…

伊面 2024-12-27 15:56:09 0 0

如何以正确的方式声明和显示与常量值相关的文档?

我正在使用 Ruby on Rails 3.1.0,并尝试使用 YARD 0.7.4。我想记录常量值,因此在我的类中我声明了这一点: # [Fixnum] Test constant documentation…

厌倦 2024-12-27 14:34:44 0 0

未为所有类生成文档

我有两个类 Link 和 MetaData (代码如下)。这些类位于同一文件夹中。但是,在 Doxygen 生成的文档中,类 Link 已记录,但类 MetaData 未记录。有什…

甜`诱少女 2024-12-27 14:01:02 1 0

ASPX/ASCX 页面/控件的呼叫概述

Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not …

二手情话 2024-12-27 12:28:15 0 0

如何用 ANSI C 编写文档注释?

Closed. This question is opinion-based. It is not currently accepting answers. 想要改进这个问题?更新问题,以便可以通过编辑这篇文章用事实和…

爱已欠费 2024-12-27 12:17:40 1 0

如何在 JSDoc 中将描述单独添加到示例中?

我想分别为每个代码示例添加描述。 例如: /** * Test function, normal description * * THE DESCRIPTION OF THE EXAMPLE HERE * @example * fooBar(…

甜味拾荒者 2024-12-27 09:24:53 1 0

使用 Ruby 的 Yard 文档工具,我可以将 Yard 配置为*不*按字母顺序放置方法吗?

我正在开发一个 Ruby 编程教程,我想用 Yard 记录该教程。默认情况下,Yard 将模块/类中的所有方法按字母顺序排列。但是,由于本教程中每个模块中的方…

烦人精 2024-12-27 07:47:15 1 0

是否有专为创建 REST API 参考文档而设计的 CMS 引擎?

我正在创建一个 REST API,用于与我们正在构建的新 SaaS 网站连接,我们需要记录该 API,以供第三方 iOS 开发人员(以及服务公开后的其他开发人员)使…

弥繁 2024-12-27 06:52:40 1 0

使用 roxygen 记录 setter 函数

我有一个函数,它的作用只不过是向任何 R 对象添加唯一的 attr 。基本演示: #' Setter function #' @param x an R object #' @param value a charact…

明月松间行 2024-12-27 04:27:29 2 0

如何记录 JavaScript/CoffeeScript 数据结构

我正在寻找一种描述性方法来记录我的 JavaScript 应用程序中使用的数据结构。由于 JavaScript 的动态特性,我发现很难完成此任务。 例如,什么是一个…

装迷糊 2024-12-27 02:57:52 1 0

Doxygen 用于在不同文件中声明的属性,使用?

我使用 mogenerator 生成 核心数据 类。 Mogenerator 产生机器类和人类类。开发人员不应修改机器生成的类,因为每次调用 mogenerator 时都会生成这些…

甜警司 2024-12-25 22:48:16 0 0

为什么我看不到外部库的 xml 注释?

我看不到外部库的 xml 注释,这正常吗? 例如,我有一个外部库,其中包含方法的 xml 注释。在引用这个库之后,我希望在使用外部库时能够出现 xml 注释…

追我者格杀勿论 2024-12-25 21:10:49 2 0

需要帮助来处理 SNMP

Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not …

对你的占有欲 2024-12-25 12:38:37 0 0
更多

推荐作者

微信用户

文章 0 评论 0

小情绪

文章 0 评论 0

ゞ记忆︶ㄣ

文章 0 评论 0

笨死的猪

文章 0 评论 0

彭明超

文章 0 评论 0

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文