标签: documentation

R 中 cons 单元存储什么?

根据 R 4.1.0 文档的 Memory{base} 帮助页面,R 为“固定”和“可变”大小的对象保留两个单独的内存区域。据我了解,可变大小的对象是用户可以在工作环境中创建的对象:向量、列表、数据框等。但是,当引用固定大小的对象时,文档相当晦涩:

[固定大小的对象]被分配为 cons 单元数组(Lisp 程序员会知道它们是什么,其他人可能会认为它们是语言本身的构建块、解析树等)[.]

有人可以提供一个存储在 cons 单元中的固定大小对象的示例吗?为了进一步参考,我知道该函数memory.profile()给出了 cons 单元的使用情况。例如,在我的会话中,这看起来像:

> memory.profile()
       NULL      symbol    pairlist     closure environment     promise    language 
          1       23363      623630        9875        2619       13410      200666 
    special     builtin        char     logical     integer      double     complex 
         47         696       96915       16105      107138       10930          22 
  character         ...         any        list  expression    bytecode externalptr 
     130101           2           0       50180           1       42219        3661 
    weakref         raw          S4 
       1131        1148        1132 
Run Code Online (Sandbox Code Playgroud)

这些计数在数字上和概念上代表什么?例如,是否logical: 16105引用存储在 R 源代码/二进制文件中的 16,105 个逻辑对象(字节?、单元格?)?

我的目的是更好地了解 R 如何在给定会话中管理内存。最后,我想我确实理解Lisp 和 …

memory documentation r cons

1
推荐指数
1
解决办法
282
查看次数

Documenter.jl:忽略文档字符串

使用Documenter.jl,我不断收到这些警告:

\n
\xe2\x94\x8c Warning: 60 docstrings not included in the manual:\n\xe2\x94\x82 \n\xe2\x94\x82     ProtoSyn.Calculators.TorchANI.r_xml_travel! :: Union{Tuple{T}, Tuple{Union{LightXML.XMLDocument, LightXML.XMLElement}, String, Vector{T}}} where T<:AbstractFloat\n\xe2\x94\x82     ProtoSyn.Clustering.dunn_index :: Union{Tuple{T}, Tuple{Vector{T}, Matrix{T}}} where T<:AbstractFloat\n\xe2\x94\x82     ProtoSyn.Calculators.get_available_energy_function_components :: Tuple{Module}\n\xe2\x94\x82     Base.resize! :: Tuple{ProtoSyn.Calculators.VerletList, Int64}\n\xe2\x94\x82     ProtoSyn.Common\n(...)\n
Run Code Online (Sandbox Code Playgroud)\n

我想忽略其中一些(大多数)文档字符串(它们存在于代码库中,但我不想将它们导出到最终文档网站)。我怎样才能忽略个别文档字符串?

\n

documentation julia

1
推荐指数
1
解决办法
238
查看次数

如何在 Python 文档字符串中添加链接?

我在 python 3.x 中有一个函数

def foo():
"""Lorem ipsum for more info, see here""
Run Code Online (Sandbox Code Playgroud)

我想添加一个指向“此处”的超链接以指向网站。在不安装外部插件的情况下如何做到这一点?

python api documentation docstring hyperlink

1
推荐指数
2
解决办法
6147
查看次数

在实现文件中包含注释类声明

每个人都知道更易读的代码的优点.因此,为了使我的代码更具可读性,我通常在该类的实现文件中包含注释类声明.
这样我就不必浏览各种include目录来定义.
那么,这是一个很好的做法还是只是过度记录?
如果有一些标准技术,请告诉我.
编辑:
有没有办法从Vim中的实现迁移到类声明?
除了在新缓冲区中打开它.

谢谢

c++ documentation comments code-readability

0
推荐指数
1
解决办法
269
查看次数

如何尝试不提供模板的可重用django应用程序?

许多可重用的django应用程序不包含内部的默认模板.James Bennett在他的演示文稿中说,提供真正可移植的默认模板的Reusable Apps非常难.他补充说,他的registration应用程序的第一个版本中的大多数错误报告都与默认模板有关.

这是一个有效的观点.但是没有任何默认模板,很难理解应用程序如何被重用,因为程序员无法看到可重用的应用程序.

你有什么建议来克服这个问题?

django documentation code-reuse django-templates

0
推荐指数
1
解决办法
227
查看次数

Doxygen python链接到函数

我正在使用Doxygen来记录我的python模块,我试图让它链接到文本中的函数.我可以将它链接到函数的命名空间ok,但不能链接到函数本身.

ModuleName::Namespace工作,但ModuleName::Namespace::getSomething()没有.

如何让这些链接起作用?

python documentation doxygen namespaces module

0
推荐指数
1
解决办法
2379
查看次数

docutils/reStructuredText模板功能

如何.rst使用实际值自定义文件中的占位符?

例如,我有example.rst以下内容的文件:

Header
------------------------------------ 
${custom_text}
Run Code Online (Sandbox Code Playgroud)

我想通过运行以下命令将${custom_text}属性替换为值this is the value of custom property:

rst2html example.rst -o example.html -Dcustom_text="this is the value of custom property"
Run Code Online (Sandbox Code Playgroud)

另外我想知道是否可以使用.properties文件自定义模板?例如,我想rst2html example.rst -o example.html -p example.properties使用example.properties包含以下内容的文件运行命令:

custom_text=this is the value of custom property
Run Code Online (Sandbox Code Playgroud)

可能吗?reStructuredText是否支持模板功能?

编辑:请注意我想从命令行或使用传统.properties文件(可以由Ant/Maven构建管理工具使用)自定义模板.

documentation markup restructuredtext docutils

0
推荐指数
1
解决办法
2099
查看次数

如何在ac/c ++程序中获取长文档字符串?

我有一个小型库,其中包含一些应该在运行时可用的文档,但MS Visual Studio C++编译器只允许长度高达2,048字节的字符串文字,这种限制是否存在一种简单的方法?我能找到的唯一解决方案是创建一个字符串数组,然后分配一个新缓冲区并将字符串复制到.

char *doc_arr[] = {
    "Documentation for my program\n",
    "\n",
    "This is a seccond line\n",
    // and so on ....
}
int doc_arr_length = 203; // number lines in doc_arr
char doc[3502];           // number of bytes in dockumentation

strcpy(doc, doc_arr[0]);
for(int i = 1; i < doc_arr_length; i++){
    strcat(doc, doc_arr[i]);
}
Run Code Online (Sandbox Code Playgroud)

更新:看起来需要一些上下文.

我有一个ruby程序,它需要很多选项并收集大量数据并生成.c文件..c文件被编译为.dll,然后在其他程序中用于快速计算.这意味着您很快就会获得许多不同的.c和.dll,并且很难管理版本.我认为在包含源文件和编译dll中的ruby脚本的选项中包含合成文档可能是个好主意.

c c++ string documentation

0
推荐指数
1
解决办法
260
查看次数

与DITA的关系

我试图在选择的概念文件之间建立关系.因此,给定三个文档"A","B"和"C",我希望它们各自显示如下内容:

一个 ...

相关概念

  • C

由于某种原因,以下不起作用:

<reltable>
    <relrow>
        <relcell>
            <topicgroup collection-type="family">
                <topicref href="topics/a.dita" type="concept"/>
                <topicref href="topics/b.dita" type="concept"/>
                <topicref href="topics/c.dita" type="concept"/>
            </topicgroup>
        </relcell>
    </relrow>
</reltable>
Run Code Online (Sandbox Code Playgroud)

以下工作,但这肯定是不正确的:

<reltable>
    <relrow>
        <relcell>
            <topicgroup collection-type="family">
                <topicref href="topics/a.dita" type="concept"/>
                <topicref href="topics/b.dita" type="concept"/>
                <topicref href="topics/c.dita" type="concept"/>
            </topicgroup>
        </relcell>
        <relcell>
            <topicgroup collection-type="family">
                <topicref href="topics/a.dita" type="concept"/>
                <topicref href="topics/b.dita" type="concept"/>
                <topicref href="topics/c.dita" type="concept"/>
            </topicgroup>
        </relcell>
    </relrow>
</reltable>
Run Code Online (Sandbox Code Playgroud)

我正在使用XMLMind 的开源DITA转换器.

xml documentation dita

0
推荐指数
1
解决办法
353
查看次数

如何使用Pydoc生成文档

我需要使用pydoc从注释中生成文档.这样做的基本步骤是什么?

python documentation pydoc

0
推荐指数
1
解决办法
6971
查看次数