当前位置: 首页 > 后端技术 > Python

Python自学教程2:大牛们是怎么写注释的

时间:2023-03-26 10:52:33 Python

开始学习代码之前,首先要学会写注释。不会写注释的程序员会被鄙视和唾弃,甚至会在工作中被穿小鞋。注释不是随便写的,用好还是有点讲究的。注释有什么用?注释(Comments)主要是向阅读代码的人说明某些代码的作用和作用,可以出现在代码的任何地方。Python在执行代码时会忽略注释,并且什么也不做,就好像它不存在一样。评论主要是给人看的,不是给机器跑的。例如。你写了一段很厉害的代码,可以让汽车自动驾驶,但是这段代码用了很多复杂的算法,别人很难看懂,所以你会在这段代码上加注释,解释代码的意思的。这样,即使别人一时难以看懂代码,也可以通过看注释知道代码做了什么。一般我们会用#来表示注释,在代码上方写上注释,说明代码的作用。#这段代码实现了自动驾驶功能#使用CNN算法实现...do_something_cnn#使用傅里叶变换do_something注解最大的作用就是提高程序的可读性,没有注解的程序简直就是别人的噩梦。我们写完代码后,可能会有代码审查。如果难以理解,公司可能会回电要求您重新填写意见。还有一种情况,半个月后你再看之前写的代码,你可能不记得为什么要这样写了。有了评论,你可以快速的为你回忆之前的实现细节。许多程序员宁愿自己开发一个应用程序也不愿修改别人的代码。缺乏合理的评论是一个重要原因。不要以为自己写的代码规范可以不加注释,容易引起同事之间的相互反感。第一种表示注释的方式是使用#,也就是上面的用法。只能用来表示某行是注释,不能表示多行。如果几行同时是注释,则需要在每一行之前。添加#号。#第一行注释#第二行注释#第三行注释do_something_with_code另一种方式是使用三引号"""""",这种方式可以很方便的写多行注释,比较常用在长注释的地方。"""这个注释比较长,因为比较长,所以我们用了三个引号,不管怎么包,都会比较方便。"""do_something_with_code快捷键表达注释时,每次都在前面加#不方便,所以常使用快捷键来表达注释。各个编辑器的快捷键会略有不同。以Pycharm为比如我们需要表达注释的时候,我们用鼠标选中要注释的代码,然后用ctrl+/快捷键自动在前面加上#,如果有多行,就选择多行即可。快捷键表示我们在写一些代码的时候经常会用到注释,所以暂时不想让这些代码跑起来,我们可以使用快捷键来快速的把这些代码转换成注释。当我们想使用的时候后面选中这些评论,按快捷键,会切换回代码。不同的,y通常是相同的。现在开始写代码似乎还早了点,但是我觉得良好的注释习惯可以快速提高写代码的速度。那么,一套好的评论习惯会包含哪些要素呢?要素一:使用注释在每个自己创建的文件中写明作者、联系方式、创建时间,这样别人看到这段代码有任何问题可以第一时间联系你。#------------------------#作者:九持#微信ID:jiubing1#公众号:九控#---------------------------------------------在Pycharm中,你不需要每次创建文件时都手动输入这些注释,可以通过创建模板自动添加。有了模板之后,每次新建一个文件,pycharm都会自动带上这些注释。在Pycharm中,点击File→Settings→Editor→FileandcodeTemplates,在右侧找到PythonScript,如下图。会变的时间直接用花括号括起来,不会变的可以直接写。Element2:Explainthisfileatthetopofthefile这里可以解释一下这个文件的具体用法,甚至可以举一些例子,方便其他人效仿。"""数据操作模块。主要是对数据库的封装操作,包括查询数据、插入数据、更新数据。具体用法如下:..."""要素三:在每个函数下面使用多行注释写下函数的功能。classDAO:definsert_rows(self,table_name,data_set):"""将excel文件数据导入数据库"""pass元素4:单行注释要适当,单行注释太多会影响别人阅读代码。试想一下,你的代码写得很好,很容易理解,但是如果你想写一行代码来解释它的意思,那就有点画蛇添足了。所以单行注释只能在特别难懂的代码上适度加,没必要对每一行代码都进行解释。#为特别困难的代码语法写注释。但是如果你真的想使用它,光知道语法是不够的。一定要始终把编程带入到具体的工作中。如果没有具体的使用场景,学再多的语法也没有用。我也准备了很多学习技巧和面试套路,基本上可以从九山文字名片上获得,顺便说一句。很多自学Python的人,看了很多教程,但到头来还是不知道怎么用,也不敢用。原因是他们没有根据实际情况来学习它。他们总是认为自己学的知识越多越好。其实很多语法根本不需要学,因为你这辈子用不到,而且像注释这样的语法,虽然很简单,但不一定好用。