25得票5回答
使用PHP自动文档化REST API

phpDocumentor似乎是记录PHP代码的标准,但我想知道为什么它多年来都没有更新..? 然而,它似乎不适合记录REST API的入口点; 即外部可访问的入口点,这些入口点可能是系统的最终用户感兴趣的,与记录所有内部类等内容无关 - 这只对API开发人员有利。 我正在寻找一种方法,在...

25得票1回答
使用Sphinx-apidoc从C++代码生成文档

以前有一些帖子谈论过这个话题,声称Sphinx根本不支持这个。我有些怀疑,但它可能已经更新了,或者文档被很好地隐藏起来了,因为这里有一个链接表明了相反的情况: http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains....

25得票2回答
你如何编写你的包文档?

我还没有完全想好构建软件包并编写文档的合理工作流程。 我希望尽可能多的过程(和文档)能够自动生成。 显而易见的方法似乎是使用package.skeleton创建基本软件包文件,然后通过编程覆盖DESCRIPTION文件和Rd文件。但问题在于这样做会导致自动生成的字段丢失,这些字段可以确保您...

24得票3回答
如何使用Sphinx记录Python函数参数?

我正在尝试整理我的 Python 代码文档,并决定使用 sphinx-doc,因为它看起来很不错。我喜欢如何使用标签引用其他类和方法: :class:`mymodule.MyClass` About my class. :meth:`mymodule.MyClass.myfunction` ...

24得票9回答
有比PHPDoc更好的东西吗?

有人在记录 PHP 代码时使用除 PHPDoc 之外的其他工具吗? 是否有任何读取相同文档语法但提供更丰富输出的工具?

24得票8回答
如何记录一个Makefile?

有没有一种方法可以在Makefile中编写“标准”注释,以便稍后将它们提供给类似Doxygen的程序,以输出漂亮的(例如HTML或man)文档?我想要在某个地方清晰地概述我的主要目标,但不需要太花哨。

23得票3回答
Sphinx: 支持语法高亮的语言列表是什么?

我正在使用Sphinx进行代码文档编写,代码中使用了多种语言,我想为所有代码设置代码高亮。 Sphinx简要介绍了它支持的一些语言(在此页面上),然后提到它使用Pygments进行词法分析和高亮显示。查阅Sphinx和Pygments的文档都没有给我任何线索,告诉我如何高亮Objective-...

23得票1回答
通过Roxygen添加useDynLib

我正在使用roxygen2包将我的软件包转换为使用roxygen文档。 现在,我的软件包无法加载,我认为这是由于在NAMESPACE文件中缺少useDynLib(mypackage)调用导致的。 我该如何生成这个调用?

23得票4回答
使用Excel VBA从一系列文档模板生成Word文档

大家好。我会尽量让这个问题简洁明了。:) 我的情况是 大约有40份样板Word文档,其中有一系列需要填写的字段(姓名、地址等)。这些文档过去都是手动完成的,但是这种工作很重复且繁琐。 一个用户已经填写了关于某个人的大量信息的工作簿。 我的需求是 一种编程方式(来自Excel VB...

23得票5回答
JSDoc - 如何记录原型方法

我一直在尝试使用JSDoc记录以下代码:/** * @module person */ /** * A human being. * @class * @param {string} name */ function Person(name){ this.nam...