在生成的.py文件中添加注释
SWIG: Add comments to generated .py file
使用SWIG生成c++应用程序的Python接口,是否有办法让它注释生成的.py文件中的函数?我实际上把整个。h文件拉到。I文件中,但对于一个小例子:
%module example
bool do_something_interesting(int number, string text);
swig -python example.i
生成:
...
def do_something_interesting(*args):
return _example.do_something_interesting(*args)
do_something_interesting = _example.do_something_interesting
理想情况下,我希望它能自动添加一个带有原始方法签名的注释
#bool do_something_interesting(int number, string text)
def do_something_interesting(*args):
return _example.do_something_interesting(*args)
do_something_interesting = _example.do_something_interesting
但是我完全可以在某个地方写我自己的注释(特别是如果注释可能在.h文件中)。我认为%pythonprepend
可能是一个可能的解决方案,但它在函数定义内插入代码,而不是在它之前。
EDIT:这是我在。h文件中提出的内容。这不是最漂亮的东西,但它可以做到:
#ifdef SWIG
%pythonprepend do_something_interesting(int, string) %{
"""Do some interesting thing
number:Int -- a number
text:String -- some text
"""
%}
#endif
bool do_something_interesting(int number, string text);
查看Python的SWIG中的文档字符串特性。可能会在.i文件
中放入以下行%feature("autodoc", "1")
会做你想做的(更多选项见http://www.swig.org/Doc2.0/Python.html#Python_nn65)
相关文章:
- 将成员变量添加到共享库中的类中,不会破坏二进制兼容性吗
- 如何在C++中从两个单独的for循环中添加两个数组
- POCO::PostgreSQL:如何将std::vector支持添加到`Binder::bind`
- 如何仅为一个函数添加延迟
- 将文本注释添加到exe文件mingw
- 如何使用 QSettings向我的配置文件添加注释
- 为什么添加内联程序集注释会导致 GCC 生成的代码发生如此根本的变化?
- 对于MySQLDump,添加一个注释,输出每个表转储的行数
- 如何将 JPEG 注释添加到现有的 JPEG 图像文件
- 通过添加一些特殊字符,使 /* 的含义用于取消引用和划分不用于注释
- 使用纯 C/C++向 PDF 添加注释
- 如何将未注释的代码块添加到编号的文档部分
- 使用python解析或读取CPP文件,并通过忽略CPP文件注释来添加数据
- 如何防止clang-format在注释字符后添加空格
- 在资源编译器脚本文件中添加注释
- 在生成的.py文件中添加注释
- 在Visual Studio c++中添加注释行
- 如何在Visual Studio 2013中快速向c++代码中添加XML注释
- 添加FreeText注释到PDF
- 在头文件中添加注释时会得到错误消息