python编程规范要求(新手入门必知python代码编写规范） _编程

注释是编写程序中的一种必不可少的、公认的风格规范，对于他人使得他人更易于读懂理解，对于编写者也易于维护和修改。

文章插图
这种默认规则从编程语言一开始到现在一直被认可，每种语言都有其注释写法规范，Python也不例外。
Python中的注释可分为：单行注释、多行注释、特殊注释（编码声明注释）
单行注释：
Python中以 # 标识为单行注释，#后面的内容均为注释内容，不会被解释器解释（不能换行哦）
# 判断C盘下的test.txt是否是文件os.path.isfile('C:\test.txt')# 睡眠一秒钟time.sleep(1)当然 # 也可以放在程序结尾的右侧
time.sleep(1)# 睡眠一秒钟甚至采用每行使用 # 达到多行注释的效果

# 这是单行注释复用实现多行注释（不推荐）# 这是单行注释复用实现多行注释（不推荐）print('datapro')

这样做并非不对，但是不推荐上述这样使用，Python中有其多行注释的标识符，如下
多行注释：
当需要写的注释内容较多时，Python中可以使用 ”’ ”’（六个单引号）或 “”” “”” （六个双引号）作为多行注释,注释内容放在中间
'''这是多行注释演示这是多行注释演示这是多行注释演示'''print('这是多行注释演示')

"""判断C盘下的test.txt是否是文件如果是则睡眠一秒钟然后输出 datapro"""re = os.path.isfile('C:\test.txt')if re:time.sleep(1)print('datapro')

对方法（函数）的注释说明

def deploy(path, remote_ip, remote_path):'''这是一个自动部署程序:param remote_ip: 远程IP地址:param remote_path: 远程部署路径:return: 返回值'''pass

对类的注释说明
class Deploy(object):"""这是一个部署程序类"""编码声明注释
Python中还提供了一种用于声明编码的注释，
# -*- coding:UTF-8 -*-它是Python2.x中遗留下来的，主要是为了解决中文编码问题，在Python3中此类问题已不存在，但是为了规范、增强代码的可执行性和及时了解程序的编码，还是建议加上编码注释。
【python编程规范要求(新手入门必知python代码编写规范）】注：-*- 并没有什么实际意义，只是为了美观装饰了下，所以还可以使用以下风格
# coding:UTF-8# coding:utf-8# coding:gbk另外，有时候Python代码文件的开头也有这么一段
#!/usr/bin/env python他的作用是声明用那个python解释器去执行代码，上面的写法是Linux环境下的写法指的是使用 /usr/bin/env 目录下的python解释器去执行代码
windows环境下只要替换为windows解释器路径即可
#!C:software python其实无论哪种环境只要python解释器添加到了全局环境变量上述的声明都是不需要的。