假设我有以下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
,我有一条经验法则是,该规则应基于所选代码行中的大多数外部缩进行进行注释。
所以,第二种方法是我建议的。
对于单行注释,无需在其他代码行的缩进之间进行决定。
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句