8.Python中的注释——《跟老吕学Python编程》
Python 基本语法
注意,Python 基本语法包含了编码、标识符、保留字、注释、缩进、字符串等常用内容,是后续学习的基础和预览,是极其重要的,老吕希望大家不要随意跳过本文的学习!
Python注释
Python注释是老吕要说的第一个重点,正是这样的注释才能让大家更快的学会Python。
- 注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。
- 注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。
- 注释只是为了提高可读性,不会被计算机编译或者解释。
Python的注释有单行注释和多行注释两种。
单行注释
Python 中单行注释以
#
开头,后面跟着注释内容。
重注1:#和注释内容一般建议以一个空格隔开
老吕举栗1:
print("Hello, World1!")
# 老吕写的第1个注释,想让电脑跟我说Hello, World1!
运行显示:
Hello, World!
老吕举栗2:
Python代码后面也是可以直接写注释的
重注2:要运行的代码和#一般建议以两个空格隔开
# #符号后就是老吕写的第1个注释
print("Hello, World2!") # 老吕写的第2个注释
# 老吕写的第3个注释:以上代码的目的是想让电脑跟我说Hello, World2!
运行显示:
Hello, World2!
老吕举栗3:
Python代码后面也是可以写多行注释的
重注2:要运行的代码和#一般建议以两个空格隔开
print("Hello, World3!")
# 老吕写注释1
# 老吕写注释2
# 老吕写注释3
# 老吕写注释4
运行显示:
Hello, World3!
多行注释
Python 使用三个连续的单引号(‘’')或者三个连续的双引号(“”")注释多行内容
老吕单双引号举栗:
'''
老吕写的第1个多行注释
3个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
里面的内容全部都是注释内容
'''
print("你好,老吕")
"""
老吕写的第1个多行注释
3个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
里面的内容全部都是注释内容
"""
运行显示:
你好,老吕
多行注释常见错误1
Python 多行注释不支持嵌套
老吕举个错误栗子1:
'''
外层注释
'''
内层注释
'''
'''
运行显示:
File "C:\LVworks\LaoLv\cuowu1.py", line 4
内层注释
IndentationError: unexpected indent
不管是多行注释还是单行注释,当注释符作为字符串的一部分出现时,就不能再将它们视为注释标记,而应该看做正常代码的一部分。
多行注释常见错误1
老吕举个错误栗子2:
print('''你好老吕''')
print("""苍井空有点大""")
print("#是单行注释的开始,苍井空真的有点大")
运行显示:
print('''你好老吕''')
print("""苍井空有点大""")
print("#是单行注释的开始,老吕你说的太夸张了,苍井空还没我大")
对于第一和第二行代码,Python 没有将里面的三个引号看作是多行注释,而是将它们看作字符串的开始和结束标志。
对于第三行代码,Python 也没有将井号看作单行注释,而是将它看作字符串的一部分。
老吕想说
- 注释(Comments)用来向用户提示或解释某些代码的作用和功能,它可以出现在代码中的任何位置。Python 解释器在执行代码时会忽略注释,不做任何处理,就好像它不存在一样。
- 在调试(Debug)程序的过程中,注释还可以用来临时移除无用的代码。
- 注释的最大作用是提高程序的可读性,没有注释的程序简直就是天书,让人吐血!
- 千万不要认为你自己写的代码规范就可以不加注释,甩给别人一段没有注释的代码是对别人的不尊重,是非常自私的行为;你可以喜欢自虐,但请不要虐待别人。
- 老吕宁愿自己去开发一个应用,也不愿意去修改别人的代码,因为很多程序员编码习惯很差,没有合理的注释是一个重要的原因。虽然良好的代码可以自成文挡,但我们永远不清楚今后阅读这段代码的人是谁,他是否和你有相同的思路;或者一段时间以后,你自己也不清楚当时写这段代码的目的了。
- 一般情况下,合理的代码注释应该占源代码的 1/3 左右。
- 最后,重申一次:Python 支持两种类型的注释,分别是单行注释和多行注释。
一分钟让你记住Python注释怎么写
一开始怎么记得注释怎么写呢?
其实里面就两个东西要记得的,老吕的绕口令是——“苍井空有点大”
所谓井就是#,空就是空格,而大则是敲击键盘单双引号时候发出的“哒哒哒”的声音,音译“大大大”,也就是所谓的“有点大”,那么念起来最顺畅又好记就是这一句:“苍井空有点大”
注释的写作风格与规范
保持简洁明了
注释应该简洁明了,尽量用最少的文字表达清晰的意思。避免冗长和复杂的注释,以免影响代码的可读性。
与代码保持一致
注释应该与代码保持一致,描述代码的实际功能和作用。确保注释准确无误,以免误导读者。
添加必要的注释
在关键部分和难以理解的代码段添加注释,以便于他人理解代码的工作原理。对于复杂的函数和方法,应该提供足够的注释来解释其功能和参数。
使用有意义的注释
注释应该使用有意义的标题和描述,以便于读者理解代码的目的和作用。避免使用无意义的注释,例如“待实现”或“暂存”。
来,大家再跟我背一遍Python注释怎么记
苍井空有点大
标签:多行,Python,代码,编程,注释,老吕写,print,吕学 From: https://blog.csdn.net/molangmolang/article/details/136753321