文档字符串属性为:__doc__。这类注释写成字符串(任何字符串都行,多行时一般用三重引号块字符串),放在模块文件、函数以及类语句的顶端,在任何可执行代码前(#注释在其之前也没问题)。Python会自动封装此字符串,称为对象的__doc__属性。例如下面是mydoc.py代码文件。
''' my module docstring words go here ''' spm= 'abc' defsquare(x): ''' function documentation can we have your liver then ''' returnx**2 classEmployee: "class documentation" pass
文档字符串内容暂无标准,一般企业内部有自己的标准(例如HTML和XML)。