php注释 Python 为什么用 # 号作注释符?
发布时间:2022-09-26 15:01:16 所属栏目:Windows 来源:
导读: 大家好,欢迎来到 Crossin的编程教室 !
今天跟大家唠唠Python中的注释。
关于编程语言中的注释,其重要性基本上已为大家所共识。
然而关于注释的规范,这个话题就像我们之前聊过的缩进
今天跟大家唠唠Python中的注释。
关于编程语言中的注释,其重要性基本上已为大家所共识。
然而关于注释的规范,这个话题就像我们之前聊过的缩进
|
大家好,欢迎来到 Crossin的编程教室 ! 今天跟大家唠唠Python中的注释。 关于编程语言中的注释,其重要性基本上已为大家所共识。 然而关于注释的规范,这个话题就像我们之前聊过的缩进、终止符和命名方式一样,众口难调。 注释符通常可分为两种,即行注释与块注释(inline/block),它们在不同的编程语言中的符号可谓让人眼花缭乱。 比如行注释符,它至少有以下的 17 种之多(出自维基百科): 其中两个最大的阵营分别是“//”与“#”号: 那么,Python 为什么用“#”号作注释符,而不是“//”呢? 这个问题恐怕没办法从解析的效率、符号的辨识度和输入的便利性等方面回答,因为它们基本上没有区别。 我没有找到官方的解释,但是从这些注释符的阵营中,已经不难得出一个较为合理的解释: Python 在创造之初,从 C 和 Shell 语言中借鉴了不少东西,但它是一种脚本语言,因此在注释符这个最为基础的语言要素上,就偏向了脚本语言的传统。 在某些“类脚本语言”中,比如 yaml、conf 和 ini 等格式的配置文件,它们大多也是采用脚本语言的“#”号作为注释符。 所以,Python 行内注释符的选择,大概可以归结为一种历史原因,即借鉴了 Shell 脚本语言的写法。 相比于行注释符的多样,块注释符更加是让人眼花缭乱: 大多数写法是我从未见过的,有些甚至是难以忍受的,槽点太多! 在这份表格里php注释,我们看不到 Python,因为从严格意义上讲,Python 并没有块注释符! 一般而言,我们在连续的每行内容前面加“#”号,达到块注释的效果。块注释被看作是多个行注释。 PEP-8 中是这么建议的: Each line of a block comment starts with a # and a single space (unless it is indented text inside the comment). 有人曾在 Twitter 上发问,为什么 Python 没有块注释符? Guido 回复称,可以将多行字符串用作块注释: Python 的多行字符串用三对单引号或双引号表示,它还可以用作文档字符串(即Documentation Strings,简写docstrings)。 但是,将它当做多行注释符使用,在语义上则有点怪怪的——它表示的是一段字符串,虽然没有赋值给变量,不会生成代码,但是它并非语义上的注释。 由于脚本语言的特性,它允许我们写一段“无根的字符串”,在语法上没有问题,也没有负作用(negative effects),但是,如果把它作为注释使用,这就是一种副作用(side effects)了。 从这点上考虑,我虽然不反对有人把多行字符串写法用作块注释,但是我会更推荐大家使用“#”号作注释。 另外,对于无用的代码,最好的做法就是直接删除,如果后续发现有需要,再回退修改。详细的多行注释尽量放在文档字符串中,这样在核心代码中就会很少出现多行注释的情况了。 对于 Python 的注释符用法,大家是怎么想的呢?欢迎留言交流。 (编辑:我爱资讯网) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |
站长推荐

