记录ctype字段

Question

我正在开发一个python模块，它是c库的方便包装器。python Simulation类只是一个带有少量辅助函数的ctype结构。Simulation中的大多数参数都可以使用_fields_变量来设置。我想知道如何正确地记录这些文件。我应该把它添加到Simulation文档字符串中吗？或者，我应该编写getter/setter方法来记录变量吗？

Answer 1

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

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