1
クラスのインスタンスであると予想されるものとクラスオブジェクトであると予想されるものを区別するために、関数の引数とクラス属性の型を文書化する標準的な方法は何ですか?自分?クラス対クラスオブジェクトのインスタンスのPythonドキュメントスタイル
class TestClass(object):
def __init__(self):
pass
class Objectify(object):
def __init__(self):
pass
class NeatDocumentation(object):
"""A class demonstrating neat documentation style.
Attributes:
cls (TestClass?): A class you want to test.
obj (Objectify?): An instance of `Objectify` class.
string (str): A string because why not.
"""
def __init__(self, cls_, obj, string):
self.cls = cls_ # An instance can be created by executing self.cls()
self.obj = obj
self.string = string