Python_从零开始学习_(4) 注释

目录

 

1.  注释的作用

2.  单行注释

3.  多行注释 

4.  代码注释规范

---

1.  注释的作用

使用自己熟悉的语言, 在程序中对某些代码进行标注说明, 增强程序的可读性

ps : 一个优秀的程序员, 注释绝对是非常漂亮的

2.  单行注释

• 以  #  开头 , # 右边的所有东西都被当做说明文字 
• 示例代码如下 : 

# 这是一个单行注释
print("hello world")

为了保证代码的可读性, # 后面建议先添加一个空格

• 在代码后面增加的单行注释注释

print("注释3")  # 这是注释3

注意 : 为了保证代码的可读性,  注释和代码之间 至少要有 两个空格

3.  多行注释 

• 要在 Python 程序中适用多行注释,  可以用一对 连续的 三个 引号 (单引号和双引号都可以)
• 示例代码如下

"""
在这中间的都是注释
可以写很多

"""
print("hello world")

4.  代码注释规范

4.1  什么时候需要使用注释

扫描二维码关注公众号，回复： 3480476 查看本文章

1. 注释不是越多越好,简单的代码不需要
2. 对于 复杂的操作 ,  应该在操作开始前协商若干行注释
3. 对于 不是一目了然的代码,  应该在其行尾添加注释 ( 至少隔开代码 2 个空格 )

4.2  代码规范

• Python 官方提供有一系列 PED (Python Enhancement Proposals) 文档
• 官方代码规范文档
• 中文版的代码规范文档