Docstring for variable

前端 未结 9 1915
予麋鹿
予麋鹿 2021-01-31 13:35

Is it posible to use docstring for plain variable? For example I have module called t

def f():
    \"\"\"f\"\"\"

l = lambda x: x
\"\"\"l\"\"\"
         


        
9条回答
  •  梦毁少年i
    2021-01-31 14:19

    Epydoc allows for docstrings on variables:

    While the language doesn't directly provides for them, Epydoc supports variable docstrings: if a variable assignment statement is immediately followed by a bare string literal, then that assignment is treated as a docstring for that variable.

    Example:

    class A:
        x = 22
        """Docstring for class variable A.x"""
    
        def __init__(self, a):
            self.y = a
            """Docstring for instance variable A.y
    

提交回复
热议问题