查看原文
其他

Python基础教程:01代码的规范书写

作者一小红牛 我的Python教程 2024-01-14


遵守Python编程规则可以使代码更易于阅读、理解和维护。以下是一些遵守Python编程规则的好处:

  1. 易于阅读:使用清晰的缩进和空格,可以使代码更易于阅读和理解。

  2. 易于维护:使用适当的注释和文档,可以使代码更易于维护。

  3. 避免语法错误:使用正确的语法和语义,可以避免语法错误,从而提高代码的可靠性。

  4. 提高代码可靠性:遵守Python编程规则可以提高代码的可靠性,因为它们可以避免因为错误的代码导致的错误。

总之,遵守Python编程规则可以使代码更易于阅读、理解和维护,从而提高代码的质量和可靠性。

01 缩

Python 用代码缩进和冒号( : )来区分代码块之间的层次。实现对代码的缩进,可以使用空格或者 Tab 键操作。但无论是手动敲空格,还是使用 Tab 键,通常情况下都是采用 4个空格长度作为一个缩进量(默认情况下,一个 Tab 键就表示 4 个空格)。

在 Python 中,对于类定义、函数定义、流程控制语句、异常处理语句等,行尾的冒号和下一行的缩进,表示下一个代码块的开始,而缩进的结束则表示此代码块的结束

02 注释

注释的构成 :由#+空格,或者一对三个英文的单引号,双引号构成。

行注释:由#号加一个空格组成行内注释是与代码语句同行的注释,行内注释和代码至少要有两个空格分隔。如下图注释的

# 这是一个示例代码,使用行注释来解释代码的作用   def add(x, y):      """      这是一个函数,用于计算两个数的和      """      return x + y     # 调用函数并输出结果   result = add(2, 3)   print(result)

文档注释:公共模块,函数,类和方法,在代码中添加与代码相关的文档,以便其他人可以更好地理解代码。

03 空格与换行

空格:运算符比如赋值(=)、比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not)算术操作符两边的空格可灵活使用,但两侧务必要保持一致)、函数参数、变量名和逗号后面添加空格。

换行:在代码块之间添加适当的空行,以使代码更易于阅读和理解。


04 命名

# 1.模块名命名:模块尽量使用小写命名首字母保持小写,尽量不要用下划线,除非多个单词,且数量不多的情况。

#2.变量命名:(wd_python_ = 0)不要使用字母I (小写的L), O (大写的O), I (大写的I)作为单字符的变量名。在有些字体里面,这些字符无法与数字0和1区分。如果想用I, 可使用L代替。变量名尽量小写, 如有多个单词,用下划线隔开。

#3.常量或者全局变量命名:全部大写,如有多个单词,用下划线隔开,全⼤写+下划线式驼峰。

# 4.函数命名:函数名应小写,如有多个单词,用下划线隔开。

① 函数名应该与函数的功能相关,并且尽可能避免使用缩写或变量名

② 函数名应该尽可能避免与变量或函数的作用域相同。

③ 函数名应该尽可能避免与已经存在的函数或变量名相同。

# 5.类命名:使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头。


完毕!!感谢您的收看

------------往期更多精彩内容------------

Python最新版本的安装教程(附详细图)

Pycharm的下载与安装方法(附教程图)

Pycharm初始化,新建一个python程序

Pycharm英文页界面,2种汉化的设置方法(教程附图)

Python常用的英文单词集合

继续滑动看下一个

Python基础教程:01代码的规范书写

作者一小红牛 我的Python教程
向上滑动看下一个

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存