原创 代码规范是什么?PEP8规范案例讲解

发布时间:2019-08-12 18:24:31 浏览 1648 来源:博学谷资讯 作者:照照

    我们都知道程序员要遵循代码规范。今天就以PEP8规范为案例,和大家谈谈“代码规范是什么”。文章从变量、函数和方法、类、模块和宝、参数等等方面讲解,希望能解决大家的一些疑问。

    代码规范是什么

     

    1.变量

     

    常量:大写加下划线 USER_CONSTANT。 私有变量 :小写和一个前导下划线 _private_value。

     

    Python 中不存在私有变量一说,若是遇到需要保护的变量,使用小写和一个前导下划线。但这只是程 序员之间的一个约定,用于警告说明这是一个私有变量,外部类不要去访问它。但实际上,外部类还是可以访问到这个变量。

     

    内置变量 : 小写,两个前导下划线和两个后置下划线 class 两个前导下划线会导致变量在解释期 间被更名。这是为了避免内置变量和其他变量产生冲突。用户定义的变量要严格避免这种风格。以免导致混乱。

     

    2.函数和方法

     

    总体而言应该使用,小写和下划线。但有些比较老的库使用的是混合大小写,即首单词小写,之后每个 单词第一个字母大写,其余小写。但现在,小写和下划线已成为规范。

     

    私有方法 :小写和一个前导下划线 这里和私有变量一样,并不是真正的私有访问权限。同时也应该注意一般函数不要使用两个前导下划线(当遇到两个前导下划线时,Python 的名称改编特性将发挥作用)。特殊方法 :小写和两个前导下划线,两个后置下划线这种风格只应用于特殊函数,比如操作符重载等。 函数参数 : 小写和下划线,缺省值等号两边无空格。

     

    3.类

     

    类总是使用驼峰格式命名,即所有单词首字母大写其余字母小写。类 名应该简明,精确,并足以从中理 解类所完成的工作。常见的一个方法是使用表示其类型或者特性的后缀,例如:SQLEngine,MimeTypes 对于基类而言,可以使用一个 Base 或者Abstract 前缀 BaseCookie, AbstractGroup。

     

    4.模块和包

     

    除特殊模块init之外,模块名称都使用不带下划线的小写字母。 若是它们实现一个协议,那么通常使用 lib 为后缀,例如: import smtplib import os import sys。

     

    5.关于参数

     

    不要用断言来实现静态类型检测。断言可以用于检查参数,但不应仅仅是进行静态类型检测。Python 是动态类型语言,静态类型检测违背了其设计思想。断言应该用于避免函数不被毫无意义的调 用。不要滥用 *args 和 **kwargs。*args 和 **kwargs 参数可能会破坏函数的健壮性。它们使签名变得模 糊,而且代码常常开始在不应该的地方构建小的参数解析器。

     

    6.其他

     

    使用 has 或 is 前缀命名布尔元素 is_connect =True has_member = False 用 复 数 形 式 命 名 序 列 members = ['user_1',

     

    'user_2'] 用显式名称命名字典

     

    person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'} 避免通用名称

     

    诸如 list, dict, sequence 或者 element 这样的名称应该避免。 避免现有名称诸如 os, sys 这种系统已经存在的名称应该避免。

     

    7.一些数字

     

    一行列数 : PEP 8 规定为 79 列。根据自己的情况,比如不要超过满屏时编辑器的显示列数。 一个函数 : 不要超过 30 行代码, 即可显示在一个屏幕类,可以不使用垂直游标即可看到整个函数。 一个类 : 不要超过 200 行代码,不要有超过 10 个方法。一个模块 不要超过 500 行。

     

    8.验证脚本可以安装一个 pep8脚本用于验证你的代码风格是否符合 PEP8。

     

    看完PEP8规范的案例讲解,相信大家都一定明白了“代码规范是什么”。如果觉得本篇文章有用,可以分享出去让更多人看见。

    申请免费试学名额    

在职想转行提升,担心学不会?根据个人情况规划学习路线,闯关式自适应学习模式保证学习效果
讲师一对一辅导,在线答疑解惑,指导就业!

上一篇: Lambda表达式在Python中的优点和缺点 下一篇: 如何使用Python爬虫抓取数据?

相关推荐 更多

    推荐课程

  • Python爬虫之Beautiful Soup教程

    免费 基础 1121

  • Python数据分析及可视化

    ¥99 基础 493

  • Python网络爬虫入门教程

    免费 基础 1977

  • Django框架搭建博客系统实战

    免费 基础 859

  • 精选大学生毕设项目-京东图书爬虫

    免费 基础 897

热门文章

  • UI设计培训费用要多少钱?靠不靠谱?
  • 哪个Python培训机构好些?怎么选?
  • 这样的Java自学姿势 学废最快
  • 2021年大数据行业发展前景及岗位方向如何?
  • Web前端开发工程师培训班哪家好?
  • 互联网产品经理岗位现在有多热门?
  • 前端测试用例怎么写?为什么写测试用例?
  • 有哪些好的线上培训产品经理的机构?
  • 零经验的人学编程难吗?能学会吗?
  • 传智博学谷神经网络和深度学习课程推荐
  • 查看更多

扫描二维码,了解更多信息

博学谷二维码