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

Question

我刚刚开始将docstring添加到我的类/方法中，并且我很难格式化它们，以便在打印时易于阅读。文档字符串中的某些行足够长，可以在我的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作为常规约定，但是您也可以只决定自己喜欢的格式，并尝试在应用程序中保持一致。