python代码规范

初步接触python,感觉就像写作文,写给谁看呢?电脑和修改作文的人。如果一篇文章一个标点符号都不写段落不分,那么人就会很难理解。但是人还可以通过联想理解和纠正文章。电脑就不一样了,说到底电脑就是一个机器,遵循着固定的规律:0与1,开与关。如果把代码顺序间隔写成一团乱麻,那电脑肯定是和写代码的初衷相差甚远,甚至无法运行。

每一种编程语言都会有其固定的代码格式规范,方便机器运行和程序猿的修改。在编写python程序代码的时候首先写#-*-coding:utf-8-*-标识,就像写作文前先选择哪种类型作文。在这里好让电脑按照utf-8编码格式进行执行我们写好的代码文件,尽可能地规避一些意想不到的错误。 如无特殊情况文件一律使用 UTF-8 编码 ,文件头部加入#-*-coding:utf-8-*-标识

python和别的编程语言最大的一个区别和特点就是缩进。缩进就是某一行代码向后退四格,使用空格退四次或者tab键退等同四个空格的距离。一般在冒号后面的代码需要另起一行并进行缩进,缩进使用四个空格。缩进后面的代码属于子代码,子代码还可以通过一定条件继续产生子代码。就像作文中人物说话时先标一个冒号,冒号后面用引号把人物说话的内容标记在内。属于从属关系。

开始写代码,每一行尽量不超过80个字符,最长不能超过120个字符。就像写作文,写的太长本子就放不下了。电脑中如果代码写太长不方便查看修改,也容易出错。尽量每行代码只写一条语句,保持代码整体的简洁,这样让代码的日常维护更高效。对于长的代码行可以缩短变量名进行折叠,也可以加入续航符强行断行。换行后的部分要多一个缩进。如果需要换行的代码在括号中直接换行就可以了但是需要和上一行括号首位对齐。

python中经常用到变量, 已经被使用的关键字不能用于声明变量python中大小写是敏感的。变量是小写,常量是大写,即使是中英标点符号混用也会出错。另外需要注意的是,在某些字体中0与1会和L小写i大写O的大写混淆不容易分清。所以命名时有需要皆用L大写和O小写。i的大写可以用L替换。

写代码的时候一些重要的不好理解的部分都标注注释。注释以#和一个空格为开始,注释都用中文。代码语句和注释要间隔两个空格以上来分开。不要使用无意义的注释描述代码,注释不需要对齐

对于一些复杂的单句不是很清晰的代码可以在代码后进行行注释解释其作用。对于技巧性部分代码,为了方便维护和审查应该在开始前进行块注释。块注释在#后面加一个空格,段落之间用#间隔。对于所有的共有模块、函数、类、方法要进行文档描述文档描述是以”””开始和结束并且自占一行,”””符号和描述文字用一个空行隔开。

每个段落主次分明的代码都让维护和修改变得高效。所以在顶级定义之间空两行,方法定义之间空一行。在觉得必要的地方以空行分开区别使整体更清晰。

在写代码时,代码内部需要用到list列表、tuple元组、二元操作符等,这些都有固定的格式。在二元操作符和算术运算符两边都加上一个空格,逗号冒号分号后加空格。参数列表、索引或切片的左括号前不加空格,在各种的右括号前都不加空格。

以上粗略讲了一些代码规格规范,下面总结罗列全部所讲。

  1. 代码开始之前皆用#-*-coding:utf-8-*-标识
  2. 缩进:即四个空格。尽量不要和tab混用。
  3. 字符数:每一行代码字符数不超过80长的代码可以用续航符进行折叠,也可以里用python里括号的隐式连接。
  4. 变量:命名要特别注意不要使用python中的关键字。
  5. 注释:行注释、块注释、文档描述。
  6. 空行:在必要的地方都应空行一行或者两行。
  7. 空格:在二元操作符、算术运算符两边都加上一个空格;逗号冒号分号后加一个空格;参数列表、索引切片左括号前不加空格,各种的右括号前也不加空格。

发表评论

电子邮件地址不会被公开。 必填项已用*标注