如何在pybind11中为C++类指定文档字符串（docstring）

你可以通过两种方式为绑定的C++类设置文档字符串：

• 构造函数传参（兼容所有pybind11版本）
  在初始化py::class_时，第三个参数就是类的文档字符串，这是最稳妥的写法：

  py::class_<Edge>(m, "Edge", "An Edge is used for representing an edge of a graph.")
      .def(py::init<int>());
  

• .doc()方法（需pybind11 v2.4及以上版本）
  如果你的pybind11版本足够新，也可以用链式调用的.doc()方法直接设置文档字符串：

  py::class_<Edge>(m, "Edge")
      .doc("An Edge is used for representing an edge of a graph.")
      .def(py::init<int>());
  

你之前的代码报错，大概率是因为使用的pybind11版本不支持通过.doc()设置类文档，优先推荐构造函数传参的方式。

内容的提问来源于stack exchange，提问作者pnklein