明智地选择您的Rdoc生产策略!

2020年6月5日

这篇文章首次发表于尼尼拉,并好心地捐助188bet app]。(您可以报告有关本页内容的问题金宝搏网址在这里)
想在r博客上分享你的内容吗?188bet app188bet app 如果你有博客,或者在这里如果你不。

[一]

最后一篇文章还在手工制作Rdoc
文件吗?”
介绍了包
wyz.code.rdoc公司生产
文档文件在一个可能完全
自动化的方式。让我们看看今天的生产策略会给你提供什么
这是最有效的方法
文档文件。

可用的武器

记住,包wyz.code.rdoc公司旨在
从代码生成文档,按代码. 它提供了很多武器
为此,让我们在这里回顾一下最重要的几点

  1. 这个ProcessingContext类允许您
    定义两种类型的操作来修改文档内容

    1. 一个无关的按需添加操作
      生成文档的无关部分
    2. 一个后处理行动
      根据需要替换/调整文档内容
  2. 这个快捷键类允许您重用大部分
    文档中常见的演示内容
  3. 这个美化课堂让你美化
    内容的呈现

要了解有关选项、签名和参数金宝搏网址的更多信息,请使用

帮助(='wyz.code.rdoc公司')装饰图案(='wyz.code.rdoc公司')

满足您的需求

在执行任何文档文件
生产,你必须决定你的操场。回答下列问题
提问有助于这样做

文档文件应该根据需要重新生成吗?
如果你
希望在创建包时随代码提供文档
答案可能是肯定的。如果您想推迟文档
生产到最后一次之前打包发货,答案是
可能没有。在这两种情况下,都是全自动的
文档文件制作。在第一种情况下,
避免任何手工制作的文件,在第二种情况下,您可以自由
这样做。

您会花费时间来完善手动生成的文件吗?

你通常应该避免手部修饰,有时是短的和
文件的有效版本可以选择更长的
为了得到想要的结果而进行的巧妙处理。

例如,当检查包,
是与文档行长度相关的检查。解决这个问题
手动或通过后处理行动开始了
根据你的选择。但每种方式所需的时间,可能是
不同。如果你想要立即获得高生产力,那就明智地选择。
没有办法断章取义地决定哪种策略是最好的
你的案子。

你的包代码有很多相同的函数参数吗
名字?

如果是这样的话,那么构造可重用的部分就可以了
允许您在生成所有文档的同时赚取大量的时间
你的包装,同时确保
一致性。包裹wyz.code.rdoc公司是非常
在这种情况下有帮助。

工业文件制作方法

你必须知道这一点wyz.code.rdoc公司手册页
生产取决于

  1. 你想要生成的文档类型:
  2. 你的代码风格

文件种类是标准的,并与目的地有关
手册页:函数,
,,或
数据. 当你制作这些手册的一页时
类型,您必须遵守不同的要求集
节的存在,节的内容,很可能也在节上
演示。

你的代码风格也会影响
你必须完成的工作才能得到一个正确填写的手册页,
格式良好,与包中的其他手册页面一致,
而且容易阅读。或者你的代码是标准R
代码
或者是攻击性编程
代码

从标准R代码到手册页

手动页面生成是部分,你就会
必须提供无关的
后处理产生他们的
内容。如果不这样做,则每个生成的手册页都将保留
不完整,无法通过包测试。这就是为什么文档
完成要求

考虑一个函数
手册页,您必须提供内容
截面图例子
描述至少。你也是
可能需要为节提供内容
细节

考虑一个手册页,你必须
为节提供内容描述
可能是部分内容细节

考虑一个数据手册页,你必须
至少为节提供内容格式
来源

从讨厌的编程R代码到手册页

使用攻击性编程R代码缓和
大量的手工页面制作。因为,这是基于参数语义的
命名,许多字段内容是从代码生成的,没有额外的负担
从而满足文档部分的要求
没有任何无关信息。

  1. 参数描述是从语义参数名推断出来的,并且
    一般不需要任何更改。因为这适用于每个
    参数的每个函数,这样的特性是伟大的
    可以赢得很多时间,
  2. 描述是从类和函数的攻击性推断出来的
    编程命名方案。如果你尊重它
    严格的模式,期望生成的内容
    锐利和定稿没有修改
    要求
    。如果你没有,你可能需要完善它
    的内容,后处理行动或一些
    手部修饰。

手动页面生成是满的除了
数据你必须提供内容的地方
上面所描述的。在所有其他情况下,生成的手册页面是完整的
为人类预览和审查做好准备。

根据你的情况选择最佳策略

首先,无论你R代码风格,一个好的
文件要求例子。这可能是
文档中最重要的部分,润色它。我已经
如前一篇文章所示,声明这些信息是多么容易
生成一个手册页。

在下面工作标准R代码、供应
无关的邮递
处理
信息输入
生产上下文前一代的定义,
为了符合
生成的手动页面。这样做,将允许立即生产
合规手册页。

使用攻击性编程R代码,只是觉得
供应无关的信息输入
生产上下文前一代的定义,
为了符合
生成的手动页面。

在下一篇文章

我们已经看到了wyz.code.rdoc公司包允许
全自动可复制手册页
生产。它有助于增强所需/所需的一致性级别
为你的您的文档文件
包。

之前没有提到但很明显,使用
wyz.code.rdoc公司缓解增量文档
一代人。创建包时,工作流通常是
调试代码,然后创建测试,然后创建文档。

wyz.code.rdoc公司,你可以领养
领域驱动的方法,即创建领域示例、实现和
调试代码,根据域示例生成文档,创建
在优先级域示例中测试重用。这样,代码生成
过程实际上是增量的和领域驱动的。

对于小尺寸的包装,这并没有显著的区别,但是
以及大尺寸的包装,这大大简化了生产,尤其是
当许多程序员在同一个包上工作时。文档可以
在代码为
交付,从而提高可见性和立即重用。

如果你寻求更高的合作和更短的隧道效应,走
对于增量交付的包功能是强大的
wyz.code.rdoc公司自动化文档
维持生产力的生产活动。

下一篇文章将提供wyz.code.rdoc公司技巧和
为了有效地生成文档,值得了解的技巧。

[一]商业
照片由yanalya创作-freepik.com网站

留下你的评论对于作者,请按照链接并在其博客上发表评论:尼尼拉

188bet app右-bloggers.com网站提供每天更新的电子邮件金宝搏网址 关于的新闻和教程金宝搏网址金宝搏网址 还有很多其他的话题。如果你想找一份R/数据科学的工作,请点击这里
想在r博客上分享你的内容吗?188bet app188bet app 如果你有博客,或者在这里如果你不。



如果你走了这么远,为什么不呢订阅更新从现场?选择您的口味:电子邮件,推特,1188bet app,或脸谱网...

评论都关门了。

搜索R-blo188bet appggers

赞助商

千万不要错过更新!
订阅R-bloggers188bet app接收
最新R帖子的电子邮件。
(您将不会再次看到此消息。)

单击此处关闭(此弹出窗口将不再出现)