当前位置 > Chrome插件首页 > Chrome插件问答 > 代码整洁之道详解实战,独特见解 -编写 Pythonic 代码编程

代码整洁之道详解实战,独特见解 -编写 Pythonic 代码编程

【Chrome插件百科】 2019-07-11 09:31:55 4143人已围观

简介编写 Pythonic 代码编程,生成器详解,装饰器使得函数和方法封装,代码中添加适当注释,变量、函数、类等的命名约定,变量和函数,变量的声明,函数的声明,类的命名规范,常量的命名规范。

 
生成器(当需要一个将返回一个序列或者在循环中执行的函数时就应该考虑使用生成器)
生成器提供了一个出色的方法,使得需要返回一系列元素的函数所需的代码更加的简单、高效。基于yield指令,可以暂停一个函数并返回中间结果。该函数将保存执行环境并在必要的时候恢复。
生成器对降低程序复杂性也有帮助,并且能够提升基于多个序列的数据转换算法的性能。把每个序列当做一个迭代器,然后将他们合并到一个高级别的函数中,这是一种避免函数变得更加庞大,丑陋,不可理解的好办法,而且,这可以给整个处理链提供实时的反馈。

装饰器(decorator)
装饰器使得函数和方法封装(接受一个函数并返回增强版本的一个函数)更加容易阅读和理解。其实总体说来,装饰器也就是一个函数,一个用来包装函数的函数,返回一个修改之后的函数对象,将其重新赋值原来的标示符,并永久丧失对原始函数对象的访问。

代码中添加适当注释
行注释仅注释复杂的操作、算法,难理解的技巧,或不够一目了然的代码;
注释和代码要隔开一定的距离,无论是行注释还是块注释;
给外部可访问的函数和方法(无论是否简单)添加文档注释,注释要清楚地描述方法的功能,并对参数,返回值,以及可能发生的异常进行说明,使得外部调用的人仅看docstring就能正确使用;
推荐在文件头中包含copyright申明,模块描述等;
注释应该是用来解释代码的功能,原因,及想法的,不该对代码本身进行解释;
对不再需要的代码应该将其删除,而不是将其注释掉;

命名
所有的编程语言都有变量、函数、类等的命名约定,以美之称的 Python 当然更建议使用命名约定。 接下来就针对类、函数、方法等等内容进行学习。

变量和函数
使用小写字母命名函数和变量,并用下划线分隔单词,提高代码可读性。

变量的声明
如果不希望外部类访问该变量,应该使用一个下划线(_)作为类的内部变量的前缀。如果要定义的私有变量名称是 Python 中的关键字如 dict 就要使用(__)。

函数的声明
函数的声明和变量一样也是通过小写字母和单下划线进行连接。
当然对于函数私有化也是和声明变量类似。

类的命名规范
类的名称应该像大多数其他语言一样使用驼峰大小写。

常量的命名规范
通常应该用大写字母定义常量名称。

代码整洁之道详解实战,独特见解 -编写 Pythonic 代码编程 相关插件

FromDocToPDF

生产工具插件 2019-06-22 21:28:50

Now enjoy immediate access to a FREE PDF converter, a MS Word® converter, translations, Wikipedia®, dictionary look-up and more!

热门Chrome插件