python代码的编写原则_python自学 第二章 python语言基础之语法特点（注释、代码缩进、编码规范）...

上一篇讲到如何安装python，从这篇开始我们将正式踏上python开发之旅，体验python带给我们的简单、快乐！

今天我们主要学习python基础的语法特点。

一、python注释

在python中，通常包含3种类型的注释，分别为单行注释、多行注释和中文编码声明注释。

1、单行注释

在python中，使用“#”作为单行注释的符合，从“#”开始直到换行为止。

语法格式：# 注释内容

2、多行注释

在python中，并没有一个单独的多行注释标记，而是将包含在一对三引号(’’’........’’’)或者(”””.......”””)之间，并且不属于任何语句的内容都可视为注释，这样的代码将被解释器忽略。由于这样的代码可以分为多行编写，所以也成为多行注释。

语法格式：'''

@功能：XXXX项目

@author:WEB前端修行日志

@创建时间：2021-01-10

'''

或者："""

@功能：XXXX项目

@author:WEB前端修行日志

@创建时间：2021-01-10

"""

多行注释通常用来为python文件、模块、类或者函数等添加版权、功能等信息

在python中，三引号(’’’........’’’)或者(”””.......”””)是字符串定界符，如果三引号作为语句的一部分出现，就不是注释，而是字符串，这一点要注意区分。

例如：'''

@功能：XXXX项目

@author:WEB前端修行日志

@创建时间：2021-01-10

'''

print('''人生苦短，我用python''')

3、中文编码声明注释

在Python中提供一种特殊的中文编码声明注释，该注释的出现主要是为了解决Python 2.x中不支持直接写中文的问题。虽然在Python 3.x中，该问题已经不存在了。但是为了规范页面的编码，同时方便其他程序员及时了解文件所用的编码，建议在文件开始加上中文编码声明注释。

语法格式：# -*- coding: 编码 -*-

或者：# coding=编码

在上面的语法中，编码为文件所使用的字符编码类型，如果采用UTF-8编码，则设置为utf-8；如果采用GBK编码，则设置为gbk或cp936.

例如指定编码为UTF-8，可以使用下面的中文编码声明注释：# -*- coding: utf-8 -*-

说明： 在上面的代码中， -*- 没有特殊的作用，只是为了美观才加上的。所以上面的代码也可以使用“# coding=utf-8”代替。

另外，下面的代码也是正确的中文编码声明注释：# coding=utf-8

二、代码缩进

在python中，不像其他程序设计语言(JAVA、PHP等)采用大括号“{}”分割代码块，而是采用代码缩进和冒号“:”区分代码之间的层次说明：缩进可以使用空格和键实现，其中，使用空格时，通常情况下采用4个空格作为一个缩进量，而使用Tab键，则采用一个Tab键作为一个缩进量。

例如：

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

三、编码规范

1、编码规则

Python中采用PEP8作为编码规范，规范中的一些应该严格遵守的条目

(1)每个import语句只导入一个模块，尽量避免一次导入多个模块。

例如：import datetime

import random

(2)不要在行尾添加分号“；”，也不要用分号将两条命令放在同一行#不规范写法

height = float(input("请输入您的身高："));

weight = float(input("请输入您的体重："));

(3)建议每行不超过80个字符，如果超过，建议用下“()”将多行内容隐式的连接起来。不推荐使用反斜杠“”进行链接。

例如：如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:x = ('这是一个非常长非常长非常长非常长 '

'非常长非常长非常长非常长非常长非常长的字符串')

2、命名规范

Python常用的一些命名规范：

(1)模块名 ：尽量短小，并且全部使用小写字母，可以使用“_”分割多个字母，例如：game_main、game_regsiter；

(2)包名：同样尽量短小，并且全部使用小写字母，不推荐使用下划线。例如：com.mingrisoft、com.mr；

(3)类名：采用单词首字母大写形式(即Pascal风格)，例如：定义一个借书类：BorrowBook。

(4)模块内部的类：采用下划线“_”+Pascal风格的类名，例如：在BorrowBook类中的内部类：_BorrowBook

(5)函数、类的属性和方法命名规则：同模块名类似，也是全部使用小写字母，多个字母可以使用“_”分隔

(6)常量：全部使用大写字母，可以使用下划线“_”

(7)使用单下划线“_”开头的模块变量或函数是受保护的，在使用from XXX import *语句从模块中导入时这些变量或函数不能被导入

(8)双下划线“__”开头的实例变量或方法是类私有的。