注释 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 的东西。我在那里或谷歌上找不到任何东西。

谢谢！

Answer 1

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

但是，根据您的问题来决定哪个更适合注释python code，我的经验法则是它应该根据所选代码行中的大多数外部缩进行进行注释。

所以你的第二种方式是我会建议的。

对于单行注释，无需在其他代码行的缩进之间做出决定。