我正在尝试使用roxygen2为引用类对象创建文档,但是当我运行R CMD检查时,我不断收到此警告:
S4 class codoc mismatches from documentation object 'myRefClass-class':
Slots for class 'myRefClass'
Code: .xData
Inherited: .xData
Docs: field1 field2
这是与上述警告相关的ref class和roxygen2块:
#' @title myRefClass class
#' @description Description of myRefClass
#' @import methods
#' @exportClass myRefClass
#' @slot field1 A character slot
#' @slot field2 A numeric slot
myRefClass<-setRefClass(Class="myRefClass",
fields=list(field1="character",
field2="numeric"))
以下是生成的R文档:
myRefClass-class {testPackaging} R文档myRefClass类
描述
myRefClass的描述
老虎机
field1字符槽
field2数字槽
至于我能找到的文档,codoc正在测试我的代码和文档之间的一致性.据我所知,所有的插槽名称都是一样的; 也许我错过了什么.不确定文档是否应该自动将其标记为引用类,或者我是否应该以某种方式指出？我发现R文档表明插槽".xData用于启用异常类型的继承",但我不确定为什么它适用于我在这里做的或者我应该用它做什么.
我已经尝试了一些roxygen标签的排列并且保持接近这里发现的结构似乎给了我最好的结果/来自R CMD检查的最少警告:Roxygen2 - 如何@export参考类生成器？ 我一直在网上寻找roxygen2应该如何与参考类一起使用的例子; 也许我正在寻找错误的地方 - 我运气不好.
我正在使用roxygen2 v 3.1.0/RStudio版本0.98.501/R版本3.0.3/OSX 10.9.2(注意:尝试升级到roxygen2 v 4.0并且它在引用类上完全被阻塞,以至于没有文档存在根本生成)
如果有人知道使用roxygen2和引用类的CRAN包,那么我可能会看到它是如何正确完成的,或者如果有人知道我做错了什么,那么帮助将非常感激.我是R的包装建筑的新手.
我有以下代码：
class A {
/**
* Splitter for words
*
* @var null|string
*/
private $splitter = '-';
/**
* Desc...
*
* @param null|string $splitter @see $splitter
*/
function __construct(
$splitter = null
) {
// implementation
}
}
$a = new A();
当使用CTRL+Qin PhpStorm查看类构造函数的文档时，我将看到：
null|string $splitter @see $splitter
我是在做错什么，还是应该配置PhpStorm以显示的描述$splitter here。我希望这里已显示Splitter for words或链接到$splitter成员，而不仅仅是@see $splitter。
正如我检查的那样，那两个变量的名字没关系-即使构造器参数名称为$sPhpStorm仍然显示@see $splitter。
我一直在查找新的HTML5表单属性,以了解如何为移动设备制作页面.在阅读时,我遇到了"自动保存"属性.
我一直在测试它但没有发生任何事情.它的目的是什么？我的代码是否正确？它甚至与搜索有关,还是我误解了MDN？
自动保存
此属性应定义为唯一值.如果type属性的值为search,则之前的搜索词值将在页面加载的下拉列表中保留.
我的代码:
<form method="POST">
<input type="search" name="fieldxxx" autosave="unique666" required="true" autocomplete="off"/>
<button type="submit">Search</button>
</form>
我正在建立一个带有laravel的网站,并且在一个雄辩的类中对变量的文档有些麻烦.我已经看到eloquent类使用属性数组来存储所有变量.我想记录我的类中的可用属性,以便我可以轻松生成文档并使用描述进行代码完成.我尝试在类中声明变量以用于文档.我已经尝试将它们公开,但是随后又不再使用属性数组了.声明它们受保护适用于attributes-array,但未使用声明的变量,并且文档和声明在其他文件中不可用于代码完成,建议和描述.我也想避免吸气和安装.
提前致谢!
以下XML注释给出了编译时警告:
/// <summary>
/// Provides data for the <see cref="TextDraw.Click"/> event.
/// </summary>
public class TextDrawEventArgs : EventArgs
{
//...
public TextDraw TextDraw { get; private set; }
}
我希望TextDraw.Click引用TextDraw类中的事件,但它正在拾取TextDraw作为此TextDrawEventArgs类型的属性.
我该如何解决这个问题？
我正在创建.NET类库,对于每个类,我在类的顶部添加了一个文档:
/// <summary>
/// Contains helper functions for ...
/// </summary>
public static class MyHelperClass
{
/// <summary>
/// Helper function for ...
/// </summary>
public static void HelperFunction() {}
}
现在,当我编译库并将其添加为我的其他项目的引用时,当我尝试使用这个类时,我没有看到文档,例如在类的顶部:
MyHelperClass.HelperFunction(); -> Intellisense won't show up my comments
我想知道在构建库时是否需要设置一些标志？
我有一个相当复杂的项目,有相当大的文档.通过Sphinx 将普通用户指南转换为PDF make latexpdf可以很好地工作.但是,如果我还想将库引用包含在所有函数,类和模块文档中,则该命令将失败:
! LaTeX Error: Too deeply nested.
手动减少嵌套不是一种选择.Sphinx内部嵌套参数描述,功能描述,模块描述等等.因此,在每种情况下弄清楚如何减少嵌套几乎是不可能的.
这几天我一直在玩APIdoc.js,我似乎无法弄清楚如何使版本工作.据我所知,我需要根据APIDOC将旧的APIDOC注释代码保存到另一个带有@APIVersioning新/旧代码的文件中.无论我在哪里粘贴这个旧文件,我似乎无法让它工作,并且在这个例子中没有任何关于如何加载旧代码来创建这个版本的暗示.非常感谢任何协助.
这是一个有趣的忙碌的一周.我正在开发一个Rails项目并包含Grape在实现API中.
API有2个部分
我设置了应用程序,一切正常...
为了说明需要标题,我使用这样的东西......
class ProfilesApi < Grape::API
resource :profiles do
desc 'List all profiles' do
headers Authorization: {
description: 'Validates identity through JWT provided in auth/login',
required: true
}
end
get do
present User.all, with: Presenters::ProfilePresenter
end
end
end
现在问题是我在很多类似的可安装API类中进行了这种描述.
有没有一种方法可以使这种常见(一种继承),所以我不需要用每个Grape方法定义它.
desc 'List all profiles' do
headers Authorization: {
description: 'Validates identity through JWT provided in auth/login',
required: true
}
end
提前谢谢,希望你们周末愉快.
我正在记录我公司的iOS应用程序的代码,现在我转向了具有完成处理程序的方法.是否有记录完成处理程序的特定方法,或者我应该将其作为参数的一部分？
例如:
/**
Description
- Parameters:
- parameter1: description
- parameter2: description
- completion: description
*/
这是正确的方式还是有另一种更好的方法？或者它应该在文档的"返回"部分？
谢谢