python - 打印时格式化 Python 文档字符串以提高可读性

Question

我刚刚开始将文档字符串添加到我的类/方法中，并且在格式化它们以使它们在打印时易于阅读时遇到了困难。文档字符串中的某些行足够长，可以在我的 IDE 上环绕，当我在控制台中打印文档字符串时，这些中断中有很大的空白间隙。此外，我想在整个文档字符串中保持一致的缩进方案，但是这些换行符通过强制行不缩进打印而违反了它。

是否有某些我忽略的文档字符串写作最佳实践？有没有办法打印大字符串以尊重格式？

希望这是有道理的，谢谢。

标签： pythondocstring

Answer 1

通常您使用该help实用程序来查看文档字符串，它处理空格中的不一致：

>>> def test():
    """ first line
    HELLO THERE@
       ME TOO
    DOC STRING HERE
    """
    return 1

>>> help(test)
Help on function test in module __main__:

test()
    first line
    HELLO THERE@
       ME TOO
    DOC STRING HERE

>>> def test2():
    """
DOC string
text here"""
    return 5

>>> help(test2)
Help on function test2 in module __main__:

test2()
    DOC string
    text here

因此，虽然您可以参考PEP 8了解常规约定，但您也可以决定您喜欢哪种格式，并尝试在您的应用程序中保持一致。