关于python:Python自学教程2大牛们怎么写注释

52次阅读

共计 2215 个字符,预计需要花费 6 分钟才能阅读完成。

在还没开始学代码前,就要先学会写正文。不会写正文的程序员会受到鄙视和鄙弃,甚至在工作中会被人穿小鞋。正文也不是轻易写一下就行,用好正文还是有点考究的。

正文有什么用?

正文(Comments)次要是向浏览代码的人解释某些代码的作用和性能,它能够呈现在代码中的任何地位。Python 在执行代码时会疏忽正文,不做任何解决,就如同它不存在一样。正文次要是给人看的,而不是给机器运行的。

举个例子。你写了一段十分厉害的代码,能够让汽车主动驾驶的代码,然而这段代码用了很多简单的算法,别的人很难看懂,所以你就会在这一段代码中增加正文,解释下代码的意思。这样,就算他人一时间很难了解代码,也能够通过读正文晓得代码做了什么事件。

个别咱们会应用 # 号来示意正文,并且在代码上方写正文来阐明代码的作用。

# 这段代码实现了主动驾驶性能

# 应用 CNN 算法实现...
do_something_cnn

# 应用傅里叶转换
do_something

正文的最大作用是进步程序的可读性,没有正文的程序对他人来说几乎就是噩梦。咱们写完代码当前,可能会有代码审查,如果很难了解,公司可能会打回来,让你从新补齐正文。

还有一种状况,当你半个月当前再来看之前写的代码,可能基本想不起来为什么这么写。有了正文,能够迅速帮你回忆之前的实现细节。很多程序员宁愿本人去开发一个利用,也不违心去批改他人的代码,没有正当的正文是一个重要的起因。

千万不要认为你本人写的代码标准就能够不加正文,这样很容易引起共事之间的互相厌弃。

正文的示意办法

第一种形式是应用 # 号,也就是下面的用法,它只能用来示意某一行是正文,不能示意多行,如果同时有几行都是正文,就须要每一行后面都增加一个 # 号。

# 第一行正文
# 第二行正文
# 第三行正文
do_something_with_code

另一种形式是应用三引号 """""",这种形式能够十分不便的写多行正文,比拟罕用在正文比拟长的的中央。

""" 这段正文比拟长。因为比拟长,所以咱们用的是三个引号,不管怎么换行,都会比拟不便。"""
do_something_with_code

快捷键

当示意正文时,每次都要在后面加上一个 # 号是不不便的,所以常常会应用快捷键来示意正文,每个编辑器的快捷键会略微有一点区别,以 Pycharm 为例,当须要示意正文时,咱们把要正文的代码用鼠标选中,而后应用 ctrl + / 快捷键就能够主动在后面加上 # 号,如果有多行,选中多行就能够了。

快捷键示意正文常常用在咱们写了一些代码,后果临时不想让这些代码运行,就能够应用快捷键,把这些代码迅速转成正文。前面想用的的时候再选中这些正文,再按一下快捷键,就又会转回代码。

大牛们的正文习惯

在我接触到的技术大牛中,都有一套本人的正文习惯,尽管每个人会略微有点区别,然而大体上都差不多。当初都还没说开始写代码呢就学大牛,如同有点早,但我认为好的正文习惯能疾速进步写代码的速度。

那么,一套好的正文习惯会蕴含哪些因素呢?

因素一:用正文在每个本人创立的文件上阐明作者、联系方式、创立工夫,这样如果他人看到这段代码有什么疑难,能够第一工夫分割你。

# -----------------------------------------------
# Author: 九柄
# 微信号: jiubing1
# 公众号: 九柄
# -----------------------------------------------

在 Pycharm 当中,你并不需要每创立一个文件都手动输出这些正文,能够通过模板创立的形式主动增加。有了模板当前,每创立一个新文件,pycharm 会主动带上这些正文信息。

在 Pycharm 中点击 File→Settings→Editor→File and code Templates,右侧找到 Python Script, 如下图。工夫这种会变的间接用花括号括起来,不会变的就间接写。

因素二:在文件的顶部阐明一下这个文件的具体性能,在这里能够阐明一下这个文件的具体用法,甚至能够举一些例子,他人能够照着操作。

""" 数据操作模块。次要是对数据库操作的封装,包含查问数据,插入数据,更新数据。具体用法如下:...
"""

因素三:在每个函数的上面用多行正文写下函数的作用。

class DAO:    
    def insert_rows(self, table_name,data_set):
        """把 excel 文件数据导入数据库"""
        pass

因素四:单行正文要适量,太多单行正文反而会影响他人浏览代码。设想一下,你的代码原本就写得不错,也容易了解,然而偏要写一行代码就阐明一下什么意思,那就有点画龙点睛了。所以单行正文只在特地难了解的代码上适度增加就行了,不须要每行代码都阐明一下。

# 特地难懂的代码再写正文
do_something_difficultly()

总结

正文是学一门编程语言最简略的语法,实际上,这一片只讲了 # 号和 """""" 三引号这两个特地简略的语法。然而真要用起来,光会语法是不够的,编程总是要带入到具体的工作中,如果没有具体的应用场景,学再多的语法是没什么用的。

我还筹备了很多学习技巧和面试套路,根本都能够在文本名片 九柄 获取,顺便三连哦。

很多自学 Python 的人,看了很多教程,但最终还是不会用,不敢用,其中的起因就是没有依据实用性学习,总以为常识学得越多越好。
实际上,很多语法基本就没必要学,因为你这辈子都用不到,而像正文这样的语法,尽管很简略,然而要用好,也不肯定容易。

正文完
 0