注释是代码的python行,使用哪种样式?

超级英雄

假设我有以下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] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类常见问题

使用哪种设计模式来重写代码?

来自分类Dev

Scala源代码指标工具(代码行,注释行等)

来自分类Dev

在C ++代码中使用C样式的注释是一种不好的做法吗?

来自分类Dev

Intellij IDEA使用错误的注释样式

来自分类Dev

/ ** /注释样式来自哪种语言?

来自分类Dev

Intellij代码样式以对齐单行注释

来自分类Dev

如何从代码中删除C样式的注释

来自分类Dev

在Spyder中注释掉Python代码行的快捷键

来自分类Dev

用于Doxygen样式注释的Visual Studio代码段

来自分类Dev

在Python中使用strptime时,我应该使用哪种格式的代码?

来自分类Dev

如何告诉组织模式使用哪种注释语法?

来自分类Dev

Word中的简单段落文本使用哪种样式?

来自分类Dev

使用sed将C样式注释转换为C ++样式

来自分类Dev

/ ** /注释样式来自哪种语言?

来自分类Dev

批量注释/取消注释调试代码行的最佳方法?

来自分类Dev

编写手册页时应使用哪种样式?

来自分类Dev

使用sed删除c样式注释

来自分类Dev

该代码使用哪种语言/脚本?

来自分类Dev

代码注释中的不同样式

来自分类Dev

注释代码中的Python Regex

来自分类Dev

使用默认值生成 Python 3 注释的代码

来自分类Dev

Openlayers:如何根据功能选择应该使用哪种样式的popover?

来自分类Dev

如何使用 Google python 样式和 pylint 在 python 中设置长行样式?

来自分类Dev

sed 命令取消注释代码行

来自分类Dev

我有多少行无注释代码?

来自分类Dev

代码比较:在效率方面使用哪种代码更好?

来自分类Dev

使用 sed 注释特定行到 python 文件

来自分类Dev

使用顶部的注释行编辑连接的 csv - Python

来自分类Dev

使用 ls 对 Python 进行同一行注释

Related 相关文章

热门标签

归档