问题标签 [docco]

我希望在记录的 c++ 实现文件（不是头文件）上获得类似的输出，例如使用docco生成的输出。有这样的工具吗？

我正在尝试使用docco自动记录我的咖啡脚本。在下面的示例中，注释得到正确输出。但是右窗格的输出中没有给出代码......只是“未定义”作为输出。现在，我已经仔细检查了，我已经安装了必备包：Node.js、Pygments 和 CoffeeScript。

例如：东西.咖啡

我唯一能想到的是 pygments 没有输出正确的东西。这是我从docco得到的反馈：

有什么我想念的吗？

谢谢

使用 CoffeeScript 和 Docco，在生成的 HTML 中创建部分，然后可以将其用作链接，例如。

有谁知道是否有办法命名这些部分，所以它可能是（例如）：

编辑：这似乎可以通过手动添加 HTML 来实现：

但有没有其他的，也许更优雅的方式？

我有一个 ant 文件，可以用docco生成 coffeescript 文档。它工作正常，除了它当前将所有文档文件转储到 docs 文件夹中。我希望 docs 文件夹反映我的脚本目录的结构，而不是仅仅将所有文件平铺到一个目录中。

我知道 docco 有一个 --output 参数，但是我不确定如何在 docs 文件夹中为文件集中的每个文件生成 docs 目录路径，而无需一一进行。

我在 Windows 7 上运行 Docco 时遇到问题。我执行了以下操作：

1. 下载并安装了python和perl
2. 安装节点js
3. 运行 npm install -g 咖啡脚本
4. 运行 easy_install pygments
5. 运行 npm install -g pygments
6. 运行 npm install -g docco

我使用 javascript 源导航到目录：

知道问题是什么吗？

是否可以在使用 Maven 的 Java（多模块）项目上运行Marginalia ？

或者有没有其他类似于 Marginalia 或Docco的替代方案可以做到这一点？

对我来说重要的是能够将它作为一些公共 Maven 存储库的依赖项添加并立即使用它，而无需为 Docco 安装任何其他东西，例如 Node.js - 这是合理的，因为它是一个 Java 项目。

我正在使用grunt-dox grunt 插件从具有JsDoc停靠块的 JavaScript 文件中生成docco文档。

当我运行 grunt 任务时，我得到的只是一个 HTML 文件，其中只有我指定的标题。安装 grunt-dox 或运行任务没有错误。

我在 Mac OS X 10.8.3 上，但我有一种强烈的感觉，这不是它不工作的原因。

以下是一些相关文件供参考：

• Gruntfile.js
• project.json 依赖项
• dox 生成的 index.html - 请忽略带有多余空格的格式
• 我正在尝试记录的 JavaScript 文件

难道我做错了什么？有没有人让这个工作？顺便说一句，我正在运行grunt test其中包含 dox 任务。

非常感谢您的帮助，因为我已经坚持了两天并准备放弃。

更新：我试图只是运行dox --title POC public/javascripts/build/docs/docs.js > public/docs/index.html，它永远挂起。

嗯。

我想为咖啡脚本文件生成文档。我想使用 Docco。

当我使用：

它抛出错误。我想是因为文件夹在文件列表中。当我使用：

它找不到一些文件，因为我在根文件夹中没有任何文件。

如何将所有 *.coffee 文件递归地提供给控制台中的命令？

我有一个大型 Backbone 风格的应用程序（约 100 个文件），我正在尝试选择自动化文档的最佳方法。

我正在试验docco，（使用grunt-docco2）但我遇到了问题。我在左侧列出了所有文件，然后向下通过窗口而无法滚动。是否可以对它们进行分组，也许是下拉式的？

另外，是否可以生成索引页面或其他内容？Docco 似乎做了我想做的 99% 的事情，但是这两件事让我发疯了！

我正在使用 docco 作为创建咖啡脚本文档的工具。

默认情况下，我在 coffeescript 源代码中所做的每条评论都被视为文档并移至左侧（解释性）列。问题是，在我的源代码中有一些代码行被注释掉，作为备用选项留下，我想保留在右侧（代码）列中。

有没有办法告诉docco-“不要碰那个，让它像普通代码一样”？“#！” 还是“#ignore”？提前致谢。