栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Python

Python代码注释

Python 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Python代码注释

注释
  • 单行注释
  • 多行注释
  • 代码注释快捷键
  • 代码注释原则

在工作中你会发现,一个项目是由多个开发人员一起做,你要调用别人写的代码,别人也要调用你的,如果代码不加注释,不说别人看不懂,自己可能过段时间也会看不懂,所以为避免这种情况发生,一定要增加你代码的可读性。

代码注释份单行和多行注释,单行注释用#,多行注释用可以用三对双引号"“”“”", 当然用#号也可以,不过就是每一行前面都要添加#号。

单行注释

Python编程语言的单行注释常以#开头,单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或者表达式之后。

示例,忽略代码意思。

# _*_coding:utf-8_*_

count = 0
while count <= 100:  # 只要count<=100就不断执行下面的代码
    print("loop ", count)
    if count == 5:
        break
    count += 1  # 每执行一次,就把count+1,要不然就变成死循环了,因为count一直是0

print("-" * 4 + "out of while loop" + "-" * 4)
多行注释

多行注释使用单引号和双引号都可以,示例如下:

"""
多行注释,双引号
多行注释,双引号
多上注释,双引号
"""

'''
多行注释,单引号
多行注释,单引号
多行注释,单引号
'''
代码注释快捷键

选中要注释的代码,按下ctrl+/注释
取消注释使用同样的方法,选择要取消注释的代码,按下Ctrl+/取消注释

代码注释原则
  1. 不用全部加注释,只需要在自己觉得重要或者不好理解的部分添加注释即可
  2. 注释可以使用中文和英文,但绝对不要使用拼音
  3. 注释不光要给自己看,还要给别人看,所以请认真写撒
  4. 注释写在语句后方时,“#”和代码空两格!
  5. 在Pycharm中,可以使用Ctrl + Alt + L ,快速规范代码使其符合PEP8的规范,当然只是调整空行、空格一类,并不会帮你添加注释
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/853995.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号