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

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

off999 2024-10-24 12:26 15 浏览 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条件结构」if…else实现判断奇偶数

功能要求用户从键盘上输入一个整数,判断该数是奇数还是偶数。说明:能被2整除的整数叫偶数,不能被2整除的叫奇数;即该数除以2后余数为0时该数为偶数,否则该数为奇数。求余数运算符为“%”。实例代码num...

Python if else条件语句详解

前面我们看到的代码都是顺序执行的,也就是先执行第1条语句,然后是第2条、第3条……一直到最后一条语句,这称为顺序结构。但是对于很多情况,顺序结构的代码是远远不够的,比如一个程序限制了只能成年人使用,儿...

python基础篇: python中的流程控制,你都了解吗?

在之前的文章中大致的介绍过python中的流程控制语句,今天通过一些案例来详细了解一下python中的流程语句。目前python中流程控制语句,包含如下,如有遗漏欢迎留言补充。在python中条件判断...

python中if语句

if语句用来判断,当不同的条件成立去做与之对应事情;格式如下:if条件:执行代码条件为True才会去做执行代码布尔类型(bool)说到布尔类型,就像开关只有两个值一样,布尔类型的值只有两个...

python中的循环语句到底难不难

好多初学者会有一种这样的心里:循环难不难?该怎么学习?下面来给大家分析下.Python中的循环语句并不难,但需要理解其核心逻辑和应用场景。以下是针对零基础学习者的清晰解析,通过对比、示例和常见误...

Python6大基础运算符,看完这篇之后会让你有一个彻底认识

昨天我们准备好了Python程序所需要的的东西,那么今天我们开始了解Python的各种基础运算符,这些要是不熟悉下来你后面的路也会走的很艰难Python支持基础运算符,常见的算术运算符有+、-、*、/...

Python基础:条件语句和循环语句

下面会详细讲解一下Python关于条件语句和循环语句,会包含一些示例代码。我们首先来介绍条件语句(if-else),然后再讨论循环语句(for和while循环)。条件语句(if-else)在Pytho...

Python合集之Python循环语句(一)

在上一节的合集中,我们了解了Python流程控制语句中if语句的嵌套及条件表达会的相关知识,本节我们将进一步了解一下Python循环语句中的while语句的相关知识。在日常生活中很多问题都无...

Python“三步”即可爬取,毋庸置疑

声明:本实例仅供学习,切忌遵守robots协议,请不要使用多线程等方式频繁访问网站。#第一步导入模块importreimportrequests#第二步获取你想爬取的网页地址,发送请求,获取网页内...

「Python条件结构」if…else实现三角形判断

功能要求编写程序,判断输入的三个数是否能构成三角形的三个边。如果可以,打印“可以构成三角形”;如果不可以,打印“不可以构成三角形”。构成三角形的条件是:三条边都等于0,且任何2条边的边长之和都大于第三...

Python中检查对象是否具有某个属性的方法

技术背景在Python编程中,经常会遇到需要检查一个对象是否具有某个特定属性的情况。例如,在调用对象的属性之前,需要先确认该属性是否存在,以避免引发AttributeError异常。以下将介绍几种常见...

Python条件语句:从入门到精通

导语条件语句是编程中的基础概念,它允许我们根据不同的条件执行不同的代码块。在Python中,条件语句的灵活性和易读性使其成为编写逻辑判断和流程控制的强大工具。本教程将带您深入了解Python条件语句的...

简单学Python——条件语句if

条件语句是用来判断给定的条件是否满足(表达式值是否为0或False),并根据判断的结果(真或假)决定执行的语句。Python条件语句用的是if或if和else、elif等搭配实现的。代码执行的过程:i...

Python合集之Python跳转语句(一)

在上一节的合集中,我们了解了Python循环嵌套语句的相关知识,本节我们将进一步了解一下Python跳转语句中的break的相关知识。当循环条件一直满足时,程序会一直执行下去,如果希望在中间离开循环...

新手学Python避坑,学习效率狂飙! 八、Python 布尔值判断

布尔值判断系统知识在Python里,布尔类型仅有两个值:True和False,它们常被用于条件判断。下面从几个方面展开介绍:1.布尔运算逻辑与(and):只有当两个操作数都为True时,...

取消回复欢迎 发表评论: