C 中的文档字符串扩展为 Python？

Question

创建 Python 的 C 扩展时，是否可以以某种方式编写公开为 docstrings 给扩展程序的用户？

Answer 1

类型的文档字符串可以作为 PyTypeObject 结构中的tp_doc 成员，请参阅文档中的示例。

函数的文档字符串可以包含在 < 模块的方法表。如果您希望文档字符串“物理上接近”实际函数，则可以在方法表中引用的函数定义上方包含字符串常量。

方法的文档字符串可以分配给< 类型成员中的 code>doc 字段表。

模块的文档字符串可以作为参数传递给Py_InitModule3() 或 Py_InitModule4() 函数。

---

更新：Python3不支持Py_InitModule3()，该方法已替换为PyModule_Create()。