python - 多行字符串的缩进

Question

我有一个使用 cmd Python 模块的脚本。cmd 模块使用三引号多行字符串作为帮助文本。像这样的东西

def x(self, strags = None):
    """class
    help text here
    and some more help text here"""

运行脚本时，命令 'help x' 将打印字符串。但是，它也会在最后两行之前打印换行符。我可以通过不缩进这些行来克服这个问题，但这会使我的代码变得丑陋{y,ier}。

如何克服这个缩进问题？专业的 Python 编码人员如何处理这个问题？

score 2 · Accepted Answer

就我个人而言，我尝试遵循PEP 8，它将读者推荐给PEP 257以获取 Docstring Conventions。它有一个关于多行文档字符串的完整部分。

score 1 · Accepted Answer

我会通过一致的缩进来处理它，如下所示：

def x(self, strags = None):
    """
    class
    help text here
    and some more help text here
    """

当然，它需要多两行，但它也通过使 doc 注释非常突出而注入了清晰度（在我看来）。

2 回答 2