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

Question

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