Pyhton 单行、多行注释符号使用方法及规范

Python 中的注释有多种,有单行注释,多行注释,批量注释,中文注释也是常用的。python注释也有自己的规范,在文章中会介绍到。注释可以起到一个备注的作用,团队合作的时候,个人编写的代码经常会被多人调用,为了让别人能更容易理解代码的通途,使用注释是非常有效的。

一、python单行注释符号(#)

井号(#)常被用作单行注释符号,在代码中使用#时,它右边的任何数据都会被忽略,当做是注释。
print 1 #输出1
#号右边的内容在执行的时候是不会被输出的。

二、批量、多行注释符号

在python中也会有注释有很多行的时候,这种情况下就需要批量多行注释符了。多行注释是用三引号'''   '''包含的,例如:
python 多行注释符
可能有的人会说这不是和多行字符串混淆了吗,但是我看到的许多程序员也是这么用的,使用时候注意区分下就好。

三、python中文注释方法

在python编写代码的时候,避免不了会出现或是用到中文,这时候你需要在文件开头加上中文注释。如果开头不声明保存编码的格式是什么,那么它会默认使用ASKII码保存文件,这时如果你的代码中有中文就会出错了,即使你的中文是包含在注释里面的。所以加上中文注释很重要。
#coding=utf-8
或者:
#coding=gbk
提示:以上两种都可以代表中文注释,我看过的更多人使用urf-8这种的比较多。

一个好的程序员,为代码加注释是必须要作的。但要确保注释要说的都是重要的事情,像看一眼就知道是干什么的,无用的代码是不需要加注释的。

### Python中的多行注释方法 在Python中,尽管没有专门的块注释语法,但可以通过特定的方式实现多行注释的功能。以下是几种常见的方法及其特点: #### 方法一:使用三重引号(`'''` 或 `"""`) 通过三重单引号或三重双引号包裹的内容可以视为一个多行字符串[^1]。这种形式常被用作文档字符串(docstrings),也可以当作多行注释使用。 ```python ''' 这是一个示例的多行注释。 在这里,我们可以写下详细的说明文档。 多行注释可以跨越多行,以提供更多的信息。 ''' """ 这是另一种方式的多行注释使用三重双引号代替三重单引号。 效果是一样的。 """ print("Hello, World!") ``` 需要注意的是,这种方法实际上是在程序中创建了一个字符串对象,因此它仍然会被解析并占用一定的内存空间[^4]。如果这些字符串未被赋值给变量,则通常会在编译阶段优化掉,但在某些场景下仍可能影响性能。 #### 方法二:逐行添加单行注释符号 (`#`) 另一种更传统的方式来处理多行注释是利用单行注释符 `#` 对每一行分别进行注释。这种方式简单直观,且完全不会对程序执行造成任何额外负担,因为所有的注释都会被解释器忽略。 ```python # 这是一个注释 # 这是另一个注释 # 这些注释可以跨越多行 print("Hello, World!") ``` 此方法适用于需要临时禁用某段代码的情况,或者当开发者希望确保没有任何潜在副作用时使用。 --- ### 推荐实践 - 如果目的是为了编写文档字符串以便于自动生成API文档或其他用途,则应优先考虑使用三重引号的形式。 - 若仅是为了暂时屏蔽一段代码或是纯粹出于注解目的而不涉及后续运行效率考量的话,则建议采用加号标记法即每行为独立的一条单独注释语句更为合适一些[^3]。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值