格式化 Python 文档字符串以便打印时的可读性

Question

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

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

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

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 了解通常的约定，但您也可以只决定自己喜欢的格式，并尽量在您的应用程序中保持一致。

格式化 Python 文档字符串以便打印时的可读性

Formatting Python docstrings for readability when printed

python

docstring