2015-08-15 63 views
1

我正在开发一个python模块,它是c库的便捷包装。 python Simulation类只是一个带有一些辅助函数的ctypes结构。 Simulation中的大部分参数只能使用_fields_变量进行设置。我想知道如何正确记录这些。我应该只是将它添加到Simulation文档字符串?或者我应该写getter/setter方法,以便我可以记录这些变量?记录ctypes字段

+0

如果_ever_你发现自己很想用Python语言编写getter/setter方法,你应该停止和问问自己“我真的*** ***需要这个?”;答案很少会是“是”。添加它们只是让你有一些东西悬挂文档字符串是**不是一个很好的理由,恕我直言。 –

回答

3

当我做类似的事情,如果它是一个小班,我会放在同一个课堂上的一切,但如果是更大的,我通常做一个类,它仅包含字段,则与功能的一个子类。然后,您可以为您的字段类创建一个文档字符串,并为您的模拟功能创建一个单独的文档字符串。

情况因人而异,但我绝不会考虑增加getter和setter方法制作的文档的唯一目的符合一些真实的或想象的理想。