Python中定义文档字符串__doc__需要注意格式对齐的处理

Python中的文档字符串是个很不错的提升代码交付质量、编写文档方便的特征,但是需要注意在使用文档字符串时,将文档字符串标识的引号对必须遵守缩进的规则,否则Python语法检查时会无法通过,而引号内的内容对缩进则无要求,关键是此时的报错Python并不能精确定位到文档字符串部分,而是定位到后续的代码部分,让人不能快速定位。
我们来看案例:
1、文档字符串的引号顶格写
在这里插入图片描述
语法报错,并在标黄色部分解释器用红块标记错误位置,这个位置并不是错误的真正位置
2、文档字符串比类定义缩进多一个空格
在这里插入图片描述
语法报错,并将出错位置用红色条标记,这个位置并不是错误的真正位置
3、文档字符串引号正常缩进,内容非正常缩进
在这里插入图片描述
可以看到一切正常。

关于文档字符串的内容请参考:
《第8.19节 使用__doc__访问Python文档字符串(DocStrings )》

老猿Python,跟老猿学Python!
博客地址:https://blog.csdn.net/LaoYuanPython

欢迎大家点赞、评论和加关注!

原文地址:https://www.cnblogs.com/LaoYuanPython/p/11144493.html