python - 有什么好的方法可以为 swig 接口(interface)生成文档吗？

Question

我想知道有没有什么好的技术来构建/维护 界面文档。

我正在使用 swig 构建一个从 C++ 代码到 Python 的接口(interface)；大多数时候我只是 %包括 C++ 头文件。我正在处理至少几十个类(class) 和 100 多种功能，因此首选自动化工具。

理想情况下，我想在 c++ header 中使用 doxygen 格式的注释来 在 python 类/方法中填充文档字符串。

或者，生成单独的文档(ascii、html...) 也会很有用。看起来支持这种功能 在 swig 的早期版本(1.3 及更早版本)中，但我看不出有什么办法 它与 2.0.

是否有任何有用的(自动化的)技术来记录界面？

Answer 1

为了将您的 doxygen 评论添加到 python 文件中，网络上存在一个名为 doxy2swig.py 的 python 工具，如 here 所述。 .

从您的代码创建 xml 文档。然后使用工具:

doxy2swig.py index.xml documentation.i

并通过

在你的swig接口(interface)文件中导入documentation.i

%import "documentation.i"

完成了。