在 python 源码阅读 过程中发现的一些很有意思的书写习惯,学习靠拢一下:
1. Python 函数的文档字符串(docstring)的使用:
文档字符串是放置在函数定义内部顶部的字符串,用于描述函数的作用、参数、返回值以及其他相关信息。它们通常被用作函数的说明文档,便于其他开发者理解并正确使用该函数。
`r""" """`
内的内容提供了对函数 、类 等的说明,包括函数的功能描述、参数说明等。
需要注意的是,虽然这里使用了原始字符串表示(r""" """
),但一般情况下,普通字符串表示也可以用于函数的文档字符串。选择使用原始字符串表示主要是考虑到其中可能包含大量特殊字符,使用原始字符串可以方便地避免对特殊字符进行转义。
一个例子:
当鼠标悬置在该函数上空时,会有下图所示的效果,还挺好的:
也可以写一下简单的数学公式,我猜测也可以写latex:
对应于: