类定义体中的裸字符串是什么意思？

Question

以下是一段代码django.core.exceptions:

class MiddlewareNotUsed(Exception):
    "This middleware is not used in this server configuration"
    pass

类的主体中的裸字符串仅仅是文档的文字吗？还是它表现出一些魔力？

Answer 1

这是一个doc字符串:

docstring是一个字符串文字,作为模块,函数,类或方法定义中的第一个语句出现.这样的文档字符串成为该__doc__对象的特殊属性.

所有模块通常都应该有文档字符串,模块导出的所有函数和类也应该有文档字符串.公共方法(包括__init__构造函数)也应该有docstrings.包可以记录在__init__.py包目录中的文件的模块docstring中 .