Python 类定义主体中的裸字符串意味着什么?
下面是来自Python 类定义主体中的裸字符串意味着什么?,python,Python,下面是来自django.core.exceptions的代码片段: class MiddlewareNotUsed(Exception): "This middleware is not used in this server configuration" pass 类主体中的裸字符串仅仅是文档的文本吗?或者它有魔力吗?它叫a。它是a。唯一的神奇之处在于,它以\uuuu doc\uuuu的形式出现在对象上,它是一个: docstring是作为第一条语句出现的字符串文字 在模块、
django.core.exceptions
的代码片段:
class MiddlewareNotUsed(Exception):
"This middleware is not used in this server configuration"
pass
类主体中的裸字符串仅仅是文档的文本吗?或者它有魔力吗?它叫a。它是a。唯一的神奇之处在于,它以\uuuu doc\uuuu
的形式出现在对象上,它是一个:
docstring是作为第一条语句出现的字符串文字
在模块、函数、类或方法定义中。这样的文件串
成为该对象的\uuuuu doc\uuuu
特殊属性
所有模块通常应具有docstring,以及所有函数和
由模块导出的类也应该具有docstring。公开的
方法(包括\uuuu init\uuuu
构造函数)也应该具有
文档字符串。软件包可以记录在软件包的模块docstring中
\uuuu init\uuuuu.py
包目录中的文件
您可能还想添加为什么应该使用docstring。喜欢模块的自动测试功能。请不要远离它们。docstring是我最喜欢的python特性之一。1) 它们允许简单的文档记录。2) 在解释器中,可以使用
my\u对象访问对象/函数的文档字符串。\u\u doc\u
使学习新库变得更加容易。3) 它们允许使用docttest模块进行简单的单元测试。