Skip to content

编程规范

编程规范,或者说是编程语法。就像学中文一样,需要先识字、学语法,然后再自己写句子、写文章,甚至是出书。而编程也需要学习对应的规范,但是其容易学的多,因为需要记的关键字并不会很多。

注释

注释可以起到一个备注的作用,就像生活中的说明书,常见的电子物品没有说明书照样能用,但是少见的电子物品没有说明书可能就不会用了,甚至会用错。 在团队合作的时候,个人编写的代码经常会被多人调用,为了让别人能更容易理解代码的通途,使用注释是非常有效的。

Python 的注释主要有 单行注释多行注释

单行注释

# 开头,# 右边的所有东西都被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用。 示例代码如下:

python
# 这是第一个单行注释
print("hello python")

提示

为了保证代码的可读性,# 后面建议先添加一个空格,然后再编写相应的说明文字

多行注释(块注释)

如果注释信息很多,一行无法显示,就可以使用多行注释。 要在 Python 程序中使用多行注释,可以用一对连续的三个引号( 单引号和双引号都可以)。示例代码如下:

python
"""
这是一个多行注释

在多行注释之间,可以写很多很多的内容……
"""
print("hello python")

释不是越多越好,对于一目了然的代码,不需要添加注释

输入输出

可以把计算机想象为另一个世界,我们在日常使用软件时会将 现实世界的信息输入到计算机世界 , 然后计算机世界可以很快速的计算并得到准确的结果,然后再 输出到现实世界

输入输出有很多种方式,例如我们购物时输入的商品名字,然后服务器给返回商品数据。使用 PS 软件是打开图片,编辑好了之后再进行导出。 而目前来说,我们只能进行最简单的输入输出操作。

输入

input() 函数接受一个标准输入数据,执行之后会阻塞等待人从现实世界输入内容,回车之后再继续运行。

python
>>> a = input("请输入一个内容:")
请输入一个内容: 123  # 输入整数
>>> type(a)
<class 'str'>  # 字符串

输出

print() 方法用于打印输出,将计算机世界运行的结果返回到现实世界,最常见的一个函数。

python
>>> name = '正心'
>>> print(name)
正心

以下是 print() 方法的完整语法:

python
print(*objects, sep=' ', end='\n', file=sys.stdout)

参数

  • objects -- 复数,表示可以一次输出多个对象。输出多个对象时,用分隔符分割。
  • sep -- 用来间隔多个对象,默认值是一个空格。
  • end -- 用来设定以什么结尾。默认值是换行符 \n,我们可以换成其他字符串。
  • file -- 要写入的文件对象。

注意

print 函数有很多的用法,关于参数的详解我们将在后面课程中会有更深入的了解

python
>>> print('a', 'b', 'c')
a b c
>>> print('a', 'b', 'c', sep=',')
a,b,c
>>> print('a', 'b', 'c', sep=',', end='\n')
a,b,c
>>> print('a', 'b', 'c', sep=',', end='$')
a,b,c$>>>

变量

程序就是用来处理数据的,而变量就是用来存储数据的

  • 在 Python 中,每个变量在使用前都必须赋值,变量赋值以后该变量才会被创建
  • 等号(=)用来给变量赋值
    • = 左边是一个变量名
    • = 右边是存储在变量中的值
  • 变量名第一次出现是定义变量
  • 变量名再次出现,不是定义变量,而是直接使用之前定义过的变量
python
变量名 =

命名规则

开发人员在程序中自定义的一些符号的名称就叫标识符,标识符可以是变量名 、函数名、类名等。 标识符由字母、下划线和数字组成,且数字不能开头

python 中的标识符是区分大小写的,最好同时满足以见名知意的条件,起一个有意义的名字,尽量做到看一眼就知道是什么意思(提高代码可读性)。

比如:名字就定义为 name , 定义学生用 student

标识符命名规则

1、下滑线命名法

用下划线 _ 来连接所有的单词,比如 hello_world

2、大驼峰式命名法(upper camel case)

  • 每一个单字的首字母都采用大写字母,

    例如:FirstNameHelloWorld

3.小驼峰式命名法(lower camel case):

  • 第一个单词以小写字母开始;

  • 第二个单词的首字母大写,

    例如:helloWorldfirstName

提示

在 Python 中,一般情况下,所有的变量名、函数名都是用下划线命名法,类名使用大驼峰命名法。

同时 python 中的标识符是区分大小写的 name 不等于 Name

代码规范

Python 官方提供有一系列 PEP(Python Enhancement Proposals) 文档。 其中第 8 篇文档专门针对 Python 的代码格式给出了建议,也就是俗称的 PEP 8

提示

任何语言的程序员,编写出符合规范的代码,是开始程序生涯的第一步

编程习惯的重要性

  1. 可以方便排查错误
  2. 方便自己看的代码
  3. 便于别人看懂你的代码(团队协作)

良好的编程习惯的养成不能靠说,要靠多练,要在大量的编程中将其融入骨髓中。

一套系统应该具有统一的编程风格,任何编程风格都不可能是完美,应该从可维护性、可读性方面继续保持一种编程风格,而不要将多种编程风格混合在一套系统中,对于新手,难以理解如此多种风格的编码。

提示

常使用 ctrl + alt + l 快速格式化代码