python - 使用三重单引号和三重双引号的文档字符串有什么区别?

标签 python documentation docstring pep

我只是想知道两种编写 Python Docstrings (__doc__) 的方式有什么区别:

  1. 三个单引号:

    '''
    Comment goes here
    '''  
    
  2. 三个双引号:

    """
    Comment goes here
    """
    

稍后生成文档时,文档字符串的格式化方式是否有任何细微差别?

最佳答案

没有。他们是一样的。唯一的区别是第一个可以包含三个未转义双引号的序列,而第二个可以包含三个未转义单引号的序列。 (换句话说,由于分隔符不同,您可以在其中使用的字符略有不同。)

Docstrings 只是常规字符串,在 Python 中,不同的字符串定界符之间没有区别,当然,你不能在字符串内部使用字符串定界符。

关于python - 使用三重单引号和三重双引号的文档字符串有什么区别?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/13081178/

相关文章:

django - 如何将 token 身份验证添加到 swagger + django rest 框架?

rust - 如何记录二进制 Rust crate 项目?

python - 使包装器显示为它包装在 help() 中的函数

python - 使用 @property 装饰器时,Spyder 不显示文档字符串

python - 使用 Plotly Dash for Python 进行 JBeans (JMX) 监控

python - 使用 NumPy 进行快速张量旋转

Python搜索字符串并打印它所在的文件

python - 为什么 Python 3.7 数据类不支持 < > <= 和 >=,或者它们支持?

documentation - 我应该记录我的私有(private)方法吗?

python - 如何在一行 ReST 文档字符串中指定返回类型并描述返回值?