问题标签 [documentation-generation]

我们正在使用 mercurial-hg 和 git，并且想知道是否有一种方法可以从现有代码和新签入的代码创建文档。

是否有任何插件可以连接到生成文档的 mercurial-hg/git 中？

谢谢

我在使用 Doxygen 识别名称空间和模块时遇到问题。我相信问题围绕着是将 放在\addtogroup命名空间内还是命名空间外。

示例 1，在命名空间之外：

示例 2 - 在命名空间内

我希望namespace Records出现在 Doxygen命名空间选项卡下，并间接出现在模块选项卡下。单击Namespaces页面中的项目应生成一个包含Records::Interface. 单击“模块”选项卡中的项目也应生成一个包含Records::Interface.

在我的 Doxygen 文档中，我在模块中的命名空间选项卡中缺少项目，反之亦然，这是由于这种困境导致我的不一致。

那么哪个是正确的方法，示例 1 或示例 2？{Doxygen 手册对此主题并不清楚。}
Doxygen：\addtogroup
Doxygen：记录命名空间

Microsoft Help 3 随 Visual Studio 2010 提供。如何从 XML 文档文件生成 MSHC 文档文件？我一直在使用 Sandcastle Help File Builder 来生成 CHM 文档文件，但是 CHM 有点过时了。有没有人有 MS Help 3 的技能？

我正在将基于 QtHelp 的内置帮助系统实施到我的应用程序中。由于 QtHelp 是基于 Qt 的帮助集合文件，所以我需要生成一组 HTML 页面。

由于我不会单独编写文档（我的一些同事也会编写），因此我正在寻找生成这些文件的最佳方法。

我们在内部使用 Wiki，我知道文档应该用某种标记语言编写，而不是给所有作者一个所见即所得的 HTML 编辑器。

所以我的问题是，是否有工具可以帮助生成文档，这些文档可以导出为一组 HTML 文件，也可能导出为 PDF？

提前致谢！

更新：

我已经在使用 Doxygen 来生成 C++ 文档。但我并不完全在寻找 API 文档生成器，而是像 LaTeX 这样的东西，它允许您像标记文档一样格式化文档内容（很像 Wiki）。

是否可以在 roxygen 进程中将 .R 文件包含在我的包的数据目录中？

我在数据目录中放了几个 .R 文件。当它们以 data() 为源时，它们会读入原始数据文件并执行一些转换。

使用 .NET 4，如何向文档添加自定义属性？

我假设它是这样的：

我似乎找不到适用于 .NET4/interops v14 的文档。

您使用什么工具从 VB.NET 源代码创建编程流程图/文档？目前绝对没有评论/文档。我是一个初学者，即我尝试过 Sandcastle，但它超出了我的想象，无法进行，即使使用 GUI 也不行。Fatesoft 的 CodeVisual To Flowchart 是可以的，但是和代码几乎一样，我还是看不懂代码。

我正在寻找为自定义 JSF 2 复合组件库生成文档。复合组件没有在任何 faces-config.xml 文件中引用，而是复合组件的 .xhtml 文件存储在 META-INF/resources 中，并使用新的复合：接口标签来定义接口。

对于 JSP 标记库，可以使用https://taglibrarydoc.dev.java.net/生成文档，我想知道我的 JSF 2 复合组件库是否有类似的东西。

我正在与 Jaxb 合作。我想从这些类中生成 javaDoc 文件，这与我对常规 java 文件执行的方式相同吗？

在代码文档中放置示例用法的最佳实践是什么？有没有标准化的方法？使用@usage 或@notes？文档生成器是否倾向于支持这一点？

我知道这个问题应该取决于文档生成器。但是，在了解每个生成器的特性之前，我正在尝试养成使用注释样式生成文档的习惯。似乎有更多的相似之处而不是不同之处。

我已经尝试过 Doxygen 并且经常使用 AS3、JS、PHP、Obj-C、C++。

例如：

或者

谢谢