05-Python注释

注释

目标

l 注释的作用

l 单行注释(行注释)

l 多行注释(块注释)

01-注释的作用

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

02-单行注释(行注释)

l # 开头,# 右边的所有东西都被当作说明文资,而不是真正要执行的程序,只能起到辅助说明作用

l 示例代码如下:

# 这是第一个单行注释

printf(hello python)

为了保证代码的可读性,#后面建议先添加一个空格,然后再编写相应的说明文字。可以用黄色小灯泡菜单下的第一个命令可以帮忙调整代码格式,这个是pycharm所有的功能

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

l 在程序开发时,同样可以使用 # 在代码的后面(旁边)添加说明性文资

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

l 示例代码如下

printf(hello python)  #输出“hello python

03-多行注释(块注释)

l 如果需要编写的注释信息很多,一行无法显示,就可以使用多行注释

l 要在Python程序中使用多行注释,就可以用一对连续的三个引号(单引号和双引号都可以)

l 代码示例如下:

“””

这是一个多行注释

 

在多行注释之间,可以写很多很多的内容。。。。。。

“””

print(hello python)

什么时候需要使用注释?

1. 注释不是越多越好,对于一目了然的代码,不需要添加注释

2. 对于复制的操作,应该在操作开始前写上若干和注释

3. 对于不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该离开代码2个空格)

4. 绝不要描述代码,假设阅读代码的人比你更懂python,他只是不知道你的代码要做什么

在一些正规的开发团队,通常会有代码审核的惯例,就是一个团队中彼此阅读对方的代码

关于代码规范

l Python官方提供一系列PEP(Python Enhancement Proposals)文档

l 其中第8篇文档专门针对Python的代码设计格式给出了建议,也就是俗称的PEP8

l 文档地址:http://www.python.org/dev/peps/pep-0008/

l 谷歌对应有的中文文档:http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

任何语言的程序员,编写出符合规范的代码,是开始程序生涯的第一步。

猜你喜欢

转载自blog.csdn.net/qq_41200424/article/details/80299319