我只是想知道编写Python Docstrings(__doc__
)的两种方式之间有什么区别:
三个单引号:
'''
Comment goes here
'''
三个双引号:
"""
Comment goes here
"""
在生成文档时,文档字符串的格式化方式是否存在细微差别?
答案 0 :(得分:13)
没有。他们是一样的。唯一的区别是第一个可以包含三个未转义的双引号的序列,而第二个可以包含三个未转义的单引号的序列。 (换句话说,因为分隔符不同,所以你可以在其中使用的字符略有不同。)
Docstrings只是常规字符串,在Python中,不同的字符串分隔符之间没有区别,当然,你不能在字符串中使用字符串分隔符。
答案 1 :(得分:7)
这并不重要。但是,对于值得的,PEP 257 -- Docstring Conventions中显示的例子都使用“”三重双引号“”。
为了保持一致性,请始终使用“”“三重双引号”“” 文档字符串。使用r“”“raw triple double quotes”“”如果你使用任何 文档字符串中的反斜杠。对于Unicode文档字符串,请使用 u“”“Unicode三引号字符串”“”。
答案 2 :(得分:5)
选择您想要的任何款式。我个人在Python中使用单引号到处。
"String literals can be enclosed in matching single quotes (') or double quotes (")."
您决定使用哪一个并不重要。重要的是,你坚持你的决定。选择一种风格并坚持下去是一种很好的做法。