假设我有以下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上找不到任何东西。
谢谢!
根据pep8,有用于多行注释的指南,但仅针对doc string
和注释后面的代码的其他有用信息。
但是,根据您的问题来决定使用哪种更好地对python code
进行注释,我的经验法则是,该规则应基于所选代码行中的大多数外部缩进线进行注释。
所以您的第二种方法就是我的建议。
对于单行注释,无需在其他行的缩进之间进行选择。