在 Pybind11 绑定的 Cpp/H 文件中包含注释

Question

本质上，我在头文件中对与 Pybind11 绑定的类中的函数有注释，有没有办法轻松地将 C++ 文档移动到 pybind11？我在 pybind 文档中找不到对此的引用，尽管我可以手动复制和粘贴文档，但这样做很痛苦。 谢谢

Answer 1

我编写了一个名为 robotpy-build 的工具，它解析标头并从中生成 pybind11 代码，包括文档字符串。

它使用一个名为 cxxheaderparser 的 python 包（我也写过）来解析头文件，并可以为每个函数/属性提取 doxygen 注释。 doxygen 注释使用 sphinxify（由我的合作者编写）转换为文档字符串。

pybind11的作者写了一个基于clang的工具pybind11_mkdoc，它提取标题和注释来生成文档字符串，但我还没有尝试过。