记录ctypes字段

Question

我正在开发一个python模块，它是c库的便利包装器。 python Simulation类只是一个带有一些辅助函数的ctypes结构。 Simulation中的大多数参数都可以使用_fields_变量进行设置。我想知道如何妥善记录这些。我应该将它添加到Simulation docstring吗？或者我应该编写getter / setter方法，以便记录变量？

Answer 1

当我做类似的事情时，如果它是一个小类我将把所有东西放在同一个类中，但如果它更大，我通常会创建一个只包含字段的类，然后是一个带有函数的子类。然后，您可以为字段类提供docstring，为模拟函数提供单独的docstring。

YMMV，但我绝不会考虑添加getter和setter，其唯一目的是使文档符合某些真实或想象的理想。