记录 ctypes 字段
Documenting ctypes fields
我正在开发一个 python 模块，它是一个 c 库的便捷包装器。 python Simulation class 只是一个带有一些附加辅助函数的 ctypes 结构。 Simulation 中的大多数参数都可以使用 _fields_ 变量设置。我想知道如何正确记录这些。我应该将它添加到 Simulation 文档字符串中吗？还是我应该编写 getter/setter 方法以便记录变量？
当我做类似的事情时，如果它很小 class 我会把所有东西都放在同一个 class，但如果它更大，我通常会做一个 class只包含字段，然后是带有函数的子class。然后你可以为你的字段 class 和你的模拟函数单独的文档字符串。
YMMV，但我永远不会考虑添加 getter 和 setter 的唯一目的是使文档符合某些真实或想象的理想。
我正在开发一个 python 模块，它是一个 c 库的便捷包装器。 python Simulation class 只是一个带有一些附加辅助函数的 ctypes 结构。 Simulation 中的大多数参数都可以使用 _fields_ 变量设置。我想知道如何正确记录这些。我应该将它添加到 Simulation 文档字符串中吗？还是我应该编写 getter/setter 方法以便记录变量？
当我做类似的事情时，如果它很小 class 我会把所有东西都放在同一个 class，但如果它更大，我通常会做一个 class只包含字段，然后是带有函数的子class。然后你可以为你的字段 class 和你的模拟函数单独的文档字符串。
YMMV，但我永远不会考虑添加 getter 和 setter 的唯一目的是使文档符合某些真实或想象的理想。