51得票5回答
记录 C++/CLI 库代码以供从 C# 使用 - 最佳工具和实践?

我正在从事一个项目,其中一个c++/cli库主要被一个c#应用程序使用。 有没有办法让c++/cli中的代码注释在Visual Studio中对c# IntelliSense可见? 假设没有,那么记录c++/cli代码以便更容易地从c#中使用(当然还包括在c++/cli中),最好的方法是什么?...

48得票7回答
如何从Doxygen获取单个PDF文档?

当我使用Doxygen生成PDF格式的文档时,会得到许多包含单个图表的不同文件。 是否有可能获得一个组织为书的单个PDF文档,类似于HTML版本? 是否可以自动获取它,即无需手动处理LaTeX文件? 谢谢!

47得票5回答
如何在PlantUML中使用颜色生成图例?

我想基于某个特定标准在类图中给类着色,并显示一个类似以下的图例: 如果我能在PlantUML的legend和endlegend标签内添加HTML表格,我可以通过更改单元格背景来实现这一点。但是,添加HTML <table>无法生效。我还尝试使用PlantUML的salt插入表...

45得票9回答
自动生成 PHP 文档?

对于ActionScript 2,我使用了NaturalDocs。但是,它对PHP的支持相当差。我迄今为止看过doxygen和phpDocumentor,但我认为它们的输出非常丑陋。有没有人有PHP自动生成文档的经验?我更喜欢使用javadoc风格的标签,它们写起来简短易记。

45得票2回答
如何使用yardoc列出未记录的模块/类/常量/方法?

我有一个小代码库,使用YARD进行文档记录。当我运行yardoc命令时,它告诉我:Files: 40 Modules: 14 ( 0 undocumented) Classes: 39 ( 0 undocumented) Constan...

44得票2回答
Sphinx已经适合用于C++文档吗?

我想尝试使用文档生成器来为一个新的C++项目生成文档。我认为我的选择是Doxygen或Sphinx。因为我有一些Python项目想要使用Sphinx,所以我想知道Sphinx是否也适用于C++。 Sphinx 网站表明支持C++,但我找不到一个能帮助我开始编写C++文档的文档。 一个类似的问...

43得票3回答
有人使用过Sphinx来文档化C++项目吗?

Sphinx 是一个针对 Python 的新文档工具。它看起来非常不错。我想知道: Sphinx 适用于记录 C++ 项目吗? 是否有将现有文档(如 doxygen)转换为 Sphinx 格式的工具? 是否有使用 Sphinx 记录 C++ 项目的在线/可下载示例? 有没有人用过 Sphi...

40得票5回答
C++:代码文档应该写在.cpp文件还是.hpp文件中?

在哪里书写类和方法的内部代码文档是惯例? 您是在头文件(.hpp)中与相应的类/方法上方书写doc-blocks还是在源码(.cpp)文件中书写? 是否有一种被广泛尊重的规范?大多数C++项目都采用一种方式而不是另一种方式吗? 或者应该在两个地方编写文档(即在.hpp和.cpp文件中),...

40得票4回答
如何生成API文档

我需要为我创建的REST API撰写一些API文档。是否有工具可以生成类似于underscore API文档风格的漂亮HTML输出?或者可能会输出类似Twitter Bootstrap样式的HTML文件? 我看到Docco可以做注释,但实际上我只想记录API。理想情况下,我想把一个工具指向控...

37得票5回答
jQuery兼容的JavaScript文档生成器

我需要为我的JavaScript项目(使用jquery、underscore和backbone构建)选择一个类似于Java中的jdoc或Ruby中的rdoc的文档生成器。 候选者: jsdoc toolkit pdoc natural docs docco YUI doc doctool...