欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2024-03-26 18:52:23
注释是编写程序中的一种必不可少的、公认的风格规范,对于他人使得他人更易于读懂理解,对于编写者也易于维护和修改。这种默认规则从编程语言一开始到现在一直被认可,每种语言都有其注释写法规范,python也不...

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

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中此类问题已不存在,但是为了规范、增强代码的可执行性和及时了解程序的编码,还是建议加上编码注释。

注:-*- 并没有什么实际意义,只是为了美观装饰了下,所以还可以使用以下风格

# 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解释器添加到了全局环境变量 上述的声明都是不需要的。