我正在开发一个 python 模块,它是 c 库的便捷包装器。一条 python Simulation
class 只是一个带有一些附加辅助函数的 ctypes 结构。 Simulation
中的大部分参数只需使用_fields_
即可设置多变的。我想知道如何正确记录这些。我应该将其添加到 Simulation
文档字符串?或者我应该编写 getter/setter 方法以便记录变量?
最佳答案
当我做类似的事情时,如果它是一个小类,我会将所有内容放在同一个类中,但如果它更大,我通常会创建一个仅包含字段的类,然后创建一个带有函数的子类。然后,您可以为您的字段类提供一个文档字符串,并为您的模拟函数提供一个单独的文档字符串。
YMMV,但我绝不会考虑添加 getter 和 setter 的唯一目的是使文档符合某些真实或想象的理想。
关于python - 记录 ctypes 字段,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32027621/