Question

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

我开始用经典

记录我的代码

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

谢谢，

达明

Answer 1

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

此外，如果您正在编写要在Vala和C中使用的库，则快速测试表明Vala在写出C代码时会保留/**文档注释。然后，您可以使用C文档工具（尤其是GTK-Doc）生成文档。

Answer 2

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

所以你必须纠正一些文件的权利。