مستندات للبيانات؟

Question

هل هناك طريقة لوصف بيانات الوحدة بطريقة مشابهة لوصف سلسلة المستندات وحدة نمطية أو وظيفة؟

class MyClass(object):
    def my_function():
        """This docstring works!"""
        return True
    my_list = []
    """This docstring does not work!"""

Answer 1

لمعرفتي، فإنه ليس من الممكن تعيين جمل التوثيق للوحدة أعضاء البيانات.

PEP 224 تشير هذه الميزة، ولكن تم رفض PEP.

وأقترح عليك توثيق أعضاء البيانات من وحدة نمطية في docstring الوحدة النمطية:

# module.py:
"""About the module.

module.data: contains the word "spam"

"""

data = "spam"

Answer 2

هو - هي يكون من الممكن توثيق بيانات الوحدة باستخدام epydoc بناء الجملة.تعد Epydoc إحدى أدوات التوثيق الأكثر استخدامًا لـ Python.

بناء الجملة للتوثيق هو #: فوق سطر تهيئة المتغير، مثل هذا:

# module.py:

#: Very important data.
#: Use with caution.
#: @type: C{str}
data = "important data"

الآن عندما تقوم بإنشاء الوثائق الخاصة بك، data سيتم وصفه كمتغير الوحدة النمطية مع الوصف والنوع المحددين str.يمكنك الاستغناء عن @type خط.

Answer 3

وكما codeape يفسر، فإنه من غير الممكن لتوثيق أعضاء البيانات العامة.

ومع ذلك، فإنه <م> هو ممكن لتوثيق أعضاء البيانات property:

class Foo:
  def get_foo(self): ...

  def set_foo(self, val): ...

  def del_foo(self): ...

  foo = property(get_foo, set_foo, del_foo, '''Doc string here''')

وهذا سيعطي docstring إلى السمة foo، ومن الواضح.