Python 浅谈注释的重要性

最近参加了一个比赛,然后看到队友编程的代码,我觉得真的是难以下咽,几乎每个字符都要咨询他,用老师的话来说,这就是山炮编程员,所以此时的我意识到写一篇关于注释程序的重要性了,因此特地的写一篇文章帮助大家入门。

注释不止是为了自己以后看的更清楚,还是为了以后的开发人员所准备的,其实一段时间后,当需要对程序做一些修改或者是改正某个bug的时候,可能未来的我们自己都会忘记相关的细节,所以此时注释显得尤为重要。

每条注释以井号(#)开始,一直到该行末尾结束,一直到该行末尾结束。我们可以在注释中放任何东西,因为Python 会完全无视他们的存在。为了写好注释,这里给出以后几条规则:

(1) 假设读者的Python 水平和你一样(比如说,不要去解释 “ 什么是字符串 ” , 也不要去解释 “ 什么是赋值语句 ”)

(2) 不要去注释那些毫无意义的事情。比如说:

count = count +1   # add one  to count

( 3) 很多程序员会在代码上写上一些以 “ TODO ”  或者  “ FIXME ”开始的注释,目的就是为了提醒他们回来编写或清理一些未完成的一些问题。

(4) 如果你在编写某段程序的时候需要使劲思考的话,应该编写注释,以后别人不会在这个地方绞尽脑汁。尤其要注意的是,如果你在开发程序的时候或者函数编写的时候使用要点来描述,尽量写的细致一点,在开发工作完成之后,还应该将原来的要点全部保留下俩直接做解释。

(5) 同样,如果某个bug很难查明,或者其修改方案比较复杂,那么你就应该编写一条注释对其进行解释。如果不这么做,那么今后其他复杂该部分的代码的程序员就会可能认定他们没有必要这么复杂并将其改为原来的样子,从而将你的心血付诸东流。

(6)如果需要大量的注释才能解释清楚某段代码的作用,那么就应该对这些代码进行整理,比如,如果需要分别对一个函数的15个列表进行解释,那么就应该将该函数拆分成更小的代码块,每隔分别只处理较小的几个列表。

(7) 过时的注释还不如没有注释,因此修改某段代码后,一定要检查相关注释,并对其做出适当的修改以保证其仍然能够准确描述代码的功能。

(8) 注释不是越多越好,弄得整篇代码都是注释,却很少看到代码,这样就曲解了注释的意思了。

所以说,一定要养成良好的注释代码的习惯,边写代码边注释,及时的记录下来你的思路,举个例子,代码是鱼,注释就是水,有了正确的注释,鱼才能更好的生存。还有就是多提高自己对代码的解释能力,用精炼的语言表达出代码的核心价值所在,那么你写的代码就是成功的。

下面举个例子

def find_two_smallest(L):
    ‘‘‘Return a tuple of the indices of the two smallest values in list L‘‘‘
    smallest = min(L)
    min1 = L.index(smallest)
    L.remove(smallest)
    next_smallest = min(L)
    min2 = L.index(next_smallest)
    L.insert(min1,smallest)
    if min1<=min2:
        min2+=1
    return(min1,min2)
时间: 2024-10-17 14:22:38

Python 浅谈注释的重要性的相关文章

python浅谈正则的常用方法

python浅谈正则的常用方法覆盖范围70%以上 上一次很多朋友写文字屏蔽说到要用正则表达,其实不是我不想用(我正则用得不是很多,看过我之前爬虫的都知道,我直接用BeautifulSoup的网页标签去找内容,因为容易理解也方便,),而是正则用好用精通的很难(看过正则表的应该都知道,里面符号对应的方法规则有很多,很灵活),对于接触编程不久的朋友们来说很可能在编程的过程上浪费很多时间,今天我把经常会用到正则简单介绍下,如果不是很特殊基本都覆盖使用. 1.正则的简单介绍 首先你得导入正则方法 impo

Python - 浅谈Python的编译与反编译

1 - Python编译过程涉及的文件 py 源代码文件,由python.exe解释,可在控制台下运行,可用文本编辑器进行编辑: pyc 源代码文件经过编译后生成的二进制文件,无法用文本编辑器进行编辑: 执行一个.py文件后,并不会自动生成对应的.pyc文件,需要指定触发Python来创建pyc文件: - pyc是由py文件经过编译后生成的二进制字节码(byte code)文件: - pyc文件的加载速度比py文件快: - pyc文件是一种跨平台的字节码,由python的虚拟机来执行: - py

python 浅谈小数据池和编码

?. ?数据池 在说?数据池之前. 我们先看?个概念. 什么是代码块: 根据提示我们从官??档找到了这样的说法: A Python program is constructed from code blocks. A block is a piece of Python program text that is executed as a unit. The following are blocks: a module, a function body, and a class definiti

Python 浅谈索引以及常用数据类型(字符串、整型、布尔型)

1.整型(int) age = 18 py2 int 32位电脑:-2147483648-2147483647 64位电脑:-9223372036854775808-9223372036854775807 超出范围后python自动将其转换为long(长整型) 整型除法只能保留整数位 from __future__ import division v = 9/2 print(v) py3 只有int 整型除法只能保留所有 2.布尔值(bool/boolen) 只有两个值(True/False)

浅谈python中的递归

python 浅谈 递归函数 最近在自学一些python,找了些资料.自己慢慢研究到了递归函数这一章,碰到个很经典的例子.汉诺塔的移动.一开始尝试自己写的时候发现,这东西怎么可能写的出来.但是看到别人写出来以后发现,这东西真的能写出来. 本着借鉴的目的想去分析一下别人写的东西.觉得很有意思想给大家分享一下,如果有误请大家指正首先大家可以先自己想想如何能写出来. 先说一下:所谓的递归,我认为就是不断重复调用.直到return 出当前的递归循环.在我拆分的过程中,大家不妨先自己想一下结果,然后看一下

开发技术--浅谈Python函数

开发|浅谈Python函数 函数在实际使用中有很多不一样的小九九,我将从最基础的函数内容,延伸出函数的高级用法.此文非科普片~~ 前言 目前所有的文章思想格式都是:知识+情感. 知识:对于所有的知识点的描述.力求不含任何的自我感情色彩. 情感:用我自己的方式,解读知识点.力求通俗易懂,完美透析知识. 正文 首先介绍函数是什么,接着走进函数,并且发现函数的高级使用方法,最后列出常用的Python的内置函数. 函数是什么? 1.函数,在代码执行的是不执行,只有在调用函数的时候才会执行. 2.函数使用

浅谈五大Python Web框架

http://www.csdn.net/article/2011-02-17/292058 导读:作者飞龙写了一篇<浅谈Python Web框架>,文中他介绍了几个Python Web框架和自己对选择框架的分析.在他看来,用Django来快速开发一些Web运用是很不错的选择.以下是文章内容: 说到Web Framework,Ruby的世界Rails一统江湖,而Python则是一个百花齐放的世界,各种micro-framework.framework不可胜数,不完全列表见: http://wik

浅谈python字符串存储形式

http://blog.csdn.net/zhonghuan1992 钟桓 2014年8月31日 浅谈python字符串存储形式 记录一下自己今的天发现疑问并且给出自己现有知识有的回答.长话短说,用过python的人对于 == 和 is 应该不陌生,但是这里我还是介绍一下. ==是用来判断两个东西是否相等,比如: a = 10: b = 10: print(a == b): 输出是true: 再看一个例子: a = [1,2,3]; b = [1,2,3]; c = [1,2,4]; print

【python】浅谈包

python中的包可以理解为模块的集合.每个包也既可以为单包也可以有多个小包组成. Python中的package定义很简单,其层次结构与目录的层次结构相同,但是每个package必须包含一个__init__.py的文件,__init__.py可以为空文件,只要它存在,就表明此目录应被作为一个package处理. 整个包的目录结构如下: package/  ##包的目录 __init__.py ##包含的__init__.py文件 add_sub/    ##小包目录 __init__.py #