如何使用Pydoc为类属性创建文档?

时间:2017-12-24 03:22:34

标签: python pydoc

我知道pydoc可以为python类的public(不是以_开头)方法生成文档。但是如何生成属性文档?

以下是一个示例:您可以看到pydoc为3种方法和2种属性创建了domentation:

  1. __ dict__

  2. __ weakref __

  3. 所以,我的问题可以分成小问题。

    1. 为什么__dict__没有真正的信息。
    2. python类的所有属性都在__dict__中,如何为公共属性创建文档。
    3. class ImageReader(builtins.object)
       |  Helper class that provides TensorFlow image coding utilities.
       |  
       |  Methods defined here:
       |  
       |  __init__(self)
       |      Create a Reader for reading image information.
       |  
       |  decode_image(self, sess, image_data)
       |      Decode jpeg image.
       |  
       |  read_image_dims(self, sess, image_data)
       |      Read dimension of image.
       |  
       |  ----------------------------------------------------------------------
       |  Data descriptors defined here:
       |  
       |  __dict__
       |      dictionary for instance variables (if defined)
       |  
       |  __weakref__
       |      list of weak references to the object (if defined)
      

0 个答案:

没有答案