記錄ctypes字段

Question

我正在開發一個python模塊，它是c庫的便捷包裝。 python Simulation類只是一個帶有一些輔助函數的ctypes結構。 Simulation中的大部分參數只能使用_fields_變量進行設置。我想知道如何正確記錄這些。我應該只是將它添加到Simulation文檔字符串？或者我應該寫getter/setter方法，以便我可以記錄這些變量？

Answer 1

當我做類似的事情，如果它是一個小班，我會放在同一個課堂上的一切，但如果是更大的，我通常做一個類，它僅包含字段，則與功能的一個子類。然後，您可以爲您的字段類創建一個文檔字符串，併爲您的模擬功能創建一個單獨的文檔字符串。

情況因人而異，但我絕不會考慮增加getter和setter方法制作的文檔的唯一目的符合一些真實的或想象的理想。