Docstrings в C расширения для Python? - PullRequest
18 голосов
/ 07 июня 2011

При создании расширения C для Python можно ли каким-либо образом писать комментарии, которые отображаются как строки документации для пользователей расширения?

Ответы [ 2 ]

18 голосов
/ 07 июня 2011

Строки документов для типов могут быть включены в качестве элемента tp_doc в структуру PyTypeObject, см. пример в документации .

Строки документов для функций могут быть включены в поле ml_doc таблицы методов модуля . Если вы хотите, чтобы ваши строки документов были «физически близки» к фактическим функциям, вы можете включить строковые константы выше определений функций, на которые вы ссылаетесь в таблице методов.

Строки документов для методов можно назначить полю doc в таблице элементов типа .

Строки документов для модулей могут быть переданы в качестве параметра для функций Py_InitModule3() или Py_InitModule4().

0 голосов
/ 07 июня 2011

Я так не думаю, но вы должны иметь возможность манипулировать строками документов этих объектов из python.См. документы по Python для получения дополнительной информации.

...