多行字符串的缩进

Question

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

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

运行脚本时，命令'help x'将打印字符串。但是，它也会在最后两行前面打印换行符。我可以通过不缩进这些行来克服这一点，但这将使我的代码成为ugl {y，ier}。

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

Answer 1

就我个人而言，我尝试关注PEP 8，引用读者将PEP 257引用为文档字符串约定。它有关于多行文档字符串的整个部分。

Answer 2

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

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

当然，它需要两行，但是通过使文档评论能够很好地表现出来，它也注入了清晰度（在我看来）。