百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

Python基础-注释风格规范(python注释规则不包含)

off999 2024-10-24 12:26 19 浏览 0 评论


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

这种默认规则从编程语言一开始到现在一直被认可,每种语言都有其注释写法规范,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解释器添加到了全局环境变量 上述的声明都是不需要的。

更多精彩内容请关注 公众号:数据与编程之美

相关推荐

Python四种常用的高阶函数,你会用了吗

每天进步一点点,关注我们哦,每天分享测试技术文章本文章出自【码同学软件测试】码同学公众号:自动化软件测试码同学抖音号:小码哥聊软件测试1、什么是高阶函数把函数作为参数传入,这样的函数称为高阶函数例如:...

Python之函数进阶-函数加强(上)(python函数的作用增强代码的可读性)

一.递归函数递归是一种编程技术,其中函数调用自身以解决问题。递归函数需要有一个或多个终止条件,以防止无限递归。递归可以用于解决许多问题,例如排序、搜索、解析语法等。递归的优点是代码简洁、易于理解,并...

数据分析-一元线性回归分析Python

前面几篇介绍了数据的相关性分析,通过相关性分析可以看出变量之间的相关性程度。如果我们已经发现变量之间存在明显的相关性了,接下来就可以通过回归分析,计算出具体的相关值,然后可以用于对其他数据的预测。本篇...

python基础函数(python函数总结)

Python函数是代码复用的核心工具,掌握基础函数的使用是编程的关键。以下是Python函数的系统总结,包含内置函数和自定义函数的详细用法,以及实际应用场景。一、Python内置函数(...

python进阶100集(9)int数据类型深入分析

一、基本概念int数据类型基本上来说这里指的都是整形,下一届我们会讲解整形和浮点型的转化,以及精度问题!a=100b=a这里a是变量名,100就是int数据对象,b指向的是a指向的对象,...

Python学不会来打我(73)python常用的高阶函数汇总

python最常用的高阶函数有counter(),sorted(),map(),reduce(),filter()。很多高阶函数都是将一个基础函数作为第一个参数,将另外一个容器集合作为第二个参数,然...

python中有哪些内置函数可用于编写数值表达式?

在Python中,用于编写数值表达式的内置函数很多,它们可以帮助你处理数学运算、类型转换、数值判断等。以下是常用的内置函数(不需要导入模块)按类别归类说明:一、基础数值处理函数函数作用示例ab...

如何在Python中获取数字的绝对值?

Python有两种获取数字绝对值的方法:内置abs()函数返回绝对值。math.fabs()函数还返回浮点绝对值。abs()函数获取绝对值内置abs()函数返回绝对值,要使用该函数,只需直接调用:a...

【Python大语言模型系列】使用dify云版本开发一个智能客服机器人

这是我的第359篇原创文章。一、引言上篇文章我们介绍了如何使用dify云版本开发一个简单的工作流:【Python大语言模型系列】一文教你使用dify云版本开发一个AI工作流(完整教程)这篇文章我们将引...

Python3.11版本使用thriftpy2的问题

Python3.11于2022年10月24日发布,但目前thriftpy2在Python3.11版本下无法安装,如果有使用thriftpy2的童鞋,建议晚点再升级到最新版本。...

uwsgi的python2+3多版本共存(python多版本兼容)

一、第一种方式(virtualenv)1、首先,机器需要有python2和python3的可执行环境。确保pip和pip3命令可用。原理就是在哪个环境下安装uwsgi。uwsgi启动的时候,就用的哪个...

解释一下Python脚本中版本号声明的作用

在Python脚本中声明版本号(如__version__变量)是一种常见的元数据管理实践,在IronPython的兼容性验证机制中具有重要作用。以下是版本号声明的核心作用及实现原理:一、版本号...

除了版本号声明,还有哪些元数据可以用于Python脚本的兼容性管理

在Python脚本的兼容性管理中,除了版本号声明外,还有多种元数据可以用于增强脚本与宿主环境的交互和验证。以下是一些关键的元数据类型及其应用场景:一、环境依赖声明1.Python版本要求pyth...

今年回家没票了?不,我有高科技抢票

零基础使用抢票开源软件Py12306一年一度的抢票季就要到了,今天给大家科普一下一款软件的使用方法。软件目前是开源的,禁止用于商用。首先需要在电脑上安装python3.7,首先从官网下载对应的安装包,...

生猛!春运抢票神器成GitHub热榜第一,过年回家全靠它了

作者:车栗子发自:凹非寺量子位报道春节抢票正在如火如荼的进行,过年回家那肯定需要抢票,每年的抢票大战,都是一场硬战,没有一个好工具,怎么能上战场死锁呢。今天小编推荐一个Python抢票工具,送到...

取消回复欢迎 发表评论: