我只是想知道什么是编写Python文档字符串(两种方法的区别__doc__
):
三个单引号:
''' Comment goes here '''
三个引号:
""" Comment goes here """
是否有办法文档字符串的任何细微的差别而产生的文档可以在以后格式化?
我只是想知道什么是编写Python文档字符串(两种方法的区别__doc__
):
三个单引号:
''' Comment goes here '''
三个引号:
""" Comment goes here """
是否有办法文档字符串的任何细微的差别而产生的文档可以在以后格式化?
不,它们是相同的。 唯一的区别在于,第一个可以包含三个非转义双引号的序列,而第二个可以包含三个非转义单引号的序列。 (换句话说,因为分隔符是不同的,有在你可以在其内部使用的字符稍有不同。)
文档字符串都只是普通的字符串,在Python有不同之处在于不同的字符串分隔符之间没有区别,当然,你不能使用字符串中的字符串分隔符。
它并不真正的问题太多。 但是,对于什么是值得所示的例子PEP 257 -文档字符串约定全部使用“”“三双引号”“”。
为了保持一致性,始终使用“”“三双引号”“”周围文档字符串。 使用R“”“生三双引号”“”如果你使用你的文档字符串的所有反斜线。 对于Unicode文档字符串,使用u“”“统一三引号字符串”“”。
选择任何你想要的风格。 我个人在Python中无处不在使用单引号,我可以。
该文件规定:
"String literals can be enclosed in matching single quotes (') or double quotes (")."
这不要紧,你决定使用哪一个。 不管是什么,是你坚持自己的决定 。 这是很好的做法,选择一种风格,并坚持下去。