我只是想知道编写 Python Docstrings ( ) 的两种方式有什么区别__doc__
:
三个单引号:
''' Comment goes here '''
三个双引号:
""" Comment goes here """
在生成文档时,文档字符串的格式化方式是否有任何细微差别?
我只是想知道编写 Python Docstrings ( ) 的两种方式有什么区别__doc__
:
三个单引号:
'''
Comment goes here
'''
三个双引号:
"""
Comment goes here
"""
在生成文档时,文档字符串的格式化方式是否有任何细微差别?
不,它们是一样的。唯一的区别是第一个可以包含三个非转义双引号的序列,而第二个可以包含三个非转义单引号的序列。(换句话说,由于分隔符不同,您可以在其中使用的字符略有不同。)
Docstrings 只是普通的字符串,在 Python 中,不同的字符串分隔符之间没有区别,当然,你不能在字符串内部使用字符串分隔符。
信息文档PEP 257 -- Docstring Conventions建议使用"""triple double-quotes"""
以保持一致性,并且所有示例都显示相同:
为了保持一致性,请始终
"""triple double quotes"""
围绕文档字符串使用。如果r"""raw triple double quotes"""
您在文档字符串中使用任何反斜杠,请使用。对于 Unicode 文档字符串,使用u"""Unicode triple-quoted strings"""
.
使用单引号还是双引号在实践中只是一个文体问题。从这些字符串生成和发布文档时,格式没有区别。
选择你想要的任何风格。就个人而言,我在 Python 中的任何地方都使用单引号。
该文档指出:
"String literals can be enclosed in matching single quotes (') or double quotes (")."
您决定使用哪一个并不重要。重要的是你坚持你的决定。选择一种风格并坚持下去是一种很好的做法。