注释 python 行代码，使用哪种样式？

Question

假设我有以下 python 片段：

if True:
    print("a")
    print("b")
    print("c")
else:
    print("d")

我正在制作一个编辑器，它具有在选定行上切换评论的功能，但我无法决定是否使用

# if True:
    # print("a")
    # print("b")
    # print("c")
# else:
    # print("d")

或

# if True:
#     print("a")
#     print("b")
#     print("c")
# else:
#     print("d")

我更倾向于使用第二种，因为它也可以更容易地在另一个具有按列编辑功能的编辑器中打开文件。

而第一个在中间注释部分时使其更具可读性：

if True:
    print("a")
    # print("b")
    print("c")
else:
    print("d")

我想知道这种情况下是否也有类似 pep8 的东西。我在那里或 google.

上找不到任何东西

谢谢！

Answer 1

根据 pep8，有针对多行注释的指南，但仅针对 doc string 和注释后代码的其他有用信息。

然而，根据您的问题来决定使用哪个更好地注释 python code，我的经验法则是它应该根据所选代码行中最外层的缩进行进行注释。

所以你的第二种方法就是我建议的方法。

对于单行注释，无需决定其他代码行的缩进。

Commenting python lines that are code, which style to use?