python的代码文档字符串使用什么包裹

Python024

python的代码文档字符串使用什么包裹,第1张

python的代码文档字符使用什么包裹简单地理解,字符串就是“一串字符”,也就是用引号内的任何数据,比如“Hello,Charlie”是一个字符串,“How are you?”也是一个字符串。

Python 要求,字符串必须使用引号括起来,可以使用单引号或者双引号,只要成对即可。字符串中的内容几乎可以包含任何字符,英文字符也行,中文字符也行。至于字符串是用单引号括起来,还是用双引号括起来,在 Python 语言中,它们没有任何区别。比如说:str1 = 'c.biancheng.net'

str2 = "php中文网"

print(str1)

print(str2)

但需要说明的是,Python 有时候没有我们期望的那么聪明。如果字符串内容本身包含了单引号或双引号,此时就需要进行特殊处理:使用不同的引号将字符串括起来。对引号进行转义。

先看第一种处理方式。假如字符串内容中包含了单引号,则可以使用双引号将字符串括起来。例如:str3 = 'I'm a coder'

由于上面字符串中包含了单引号,此时 Python 会将字符串中的单引号与第一个单引号配对,这样就会把 'I' 当成字符串,而后面的 m a coder' 就变成了多余的内容,从而导致语法错误。

为了避免这种问题,可以将上面代码改为如下形式:str3 = "I'm a coder"

上面代码使用双引号将字符串括起来,此时 Python 就会把字符串中的单引号当成字符串内容,而不是和字符串开始的引号配对。

假如字符串内容本身包含双引号,则可使用单引号将字有串括起来,例如如下代码:str4 = '"Spring is here,let us jam!", said woodchuck.'

接下来看第二种处理方式:使用转义字符。Python 允许使用反斜线(\)将字符串中的特殊字符进行转义。假如字符串既包含单引号,又包含双引号,此时就可以使用转义字符,例如:str5 = '"we are scared,Let\'s hide in the shade",says the bird'

通过使用转义字符,向 Python 解释器表明了此单引号并不是和最前面的单引号进行配对的另一半,从而避免了发生语法错误。 此外,Python 不是格式自由的语言,它对程序的换行、缩进都有其规定的语法。Python 允许使用转义字符(\)对换行符进行转义,转义之后的换行符不会“中断”字符串。例如:s2 = 'The quick brown fox \

jumps over the lazy dog'

print(s2)

上面 s2 字符串的内容较长,故程序使用了转义字符(\)对内容进行了转义,这样就可以把一个字符串写成两行。

同样的,Python 的表达式也不允许随便换行。但如果程序需要对 Python 表达式换行,就需要使用转义字符(\),例如:num = 20 + 3 / 4 + \

2 * 3

print(num)

上面程序中有一个表达式,为了对该表达式换行,程序用到了转义字符。

4.7.6. 文档字符串

这里介绍的文档字符串的概念和格式。

第一行应该是关于对象用途的简介。简短起见,不用明确的陈述对象名或类型,因为它们可以从别的途径了解到(除非这个名字碰巧就是描述这个函数操作的动词)。这一行应该以大写字母开头,以句号结尾。

如果文档字符串有多行,第二行应该空出来,与接下来的详细描述明确分隔。接下来的文档应该有一或多段描述对象的调用约定、边界效应等。

Python 的解释器不会从多行的文档字符串中去除缩进,所以必要的时候应当自己清除缩进。这符合通常的习惯。第一行之后的第一个非空行决定了整个文档的缩进格式。(我们不用第一行是因为它通常紧靠着起始的引号,缩进格式显示的不清楚。)留白“相当于”是字符串的起始缩进。每一行都不应该有缩进,如果有缩进的话,所有的留白都应该清除掉。留白的长度应当等于扩展制表符的宽度(通常是8个空格)。

.通用实践推荐只在有关表达式、语句或一小组语句的小型文档中使用井号注释。文档字符串更适用于文件、函数或类中的更高级、更广阔的功能型文档,并且已经成为Python软件预期的一部分。除了这些守则,你还需要自行决定文档的内容。

尽管一些公司有内部标准,但关于文档字符串的文本应该包含些什么,其实并没有普适的标准。目前已经有许多标记语言和模板协议(例如,HTML或XML),但它们似乎都没有在Python世界中流行起来。坦率地讲,要让程序员手动编写HTML来为代码添加文档,基本上是天方夜谭。要求编写HTML格式的注释不仅看上去是无理取闹,而且通常也不符合文档编写的惯例。

一些程序员并没有给予文档应有的重视。很多情况下,如果你阅读的源代码有一丝注释,那都算非常走运了(且不说那些注释是否有被及时更新)。不过,强烈建议详细地为代码编写文档,因为这是写好代码很重要的步骤。不过,目前确实没有关于文档字符串结构的标准,如果想要编写文档,那么在今天一切内容都是可接受的。就像编写代码本身一样,你可以自行决定是否创建文档内容并及时更新,当然你最好使用常识来加以判断。