如何从vala代码中提取文档？答案

【问题标题】：How to extract documentation from vala code?如何从vala代码中提取文档？
【发布时间】：2011-10-15 21:00:35
【问题描述】：

我想知道是否有工具可以从 vala 源文件中提取文档，例如 javadoc 或 doxygen 用于 Java / C++ /...

我开始用经典记录我的代码

/**
 * I'm a function !
 * @arg An argument
 * @return I return nothing
 */

谢谢，

达米安

【问题讨论】：

【解决方案1】：

Valadoc 这样做。关于如何使用它的说明似乎有点稀疏。

此外，如果您正在编写一个可同时用于 Vala 和 C 的库，快速测试表明 Vala 在编写 C 代码时保留了 /** 文档 cmets。然后，您可以使用 C 文档工具（尤其是 GTK-Doc）来生成文档。

【讨论】：

【解决方案2】：

Valadoc 是构建文档的官方工具，但在某些系统上，make install 无法正常工作（对我来说，在 Ubuntu 11.10 下）。

所以你必须更正一些文件的权限。

【讨论】：