Python基础:代码规范与注释详解
本文详解Python代码的基本规范,包括文件扩展名、大小写敏感、缩进要求及换行符使用。重点介绍单行与多行注释的语法、注意事项及快捷键操作,结合PEP 8标准提升代码可读性与维护性。
前言
编写Python代码时需遵循以下基本规范:
1、Python源文件必须使用 .py 作为扩展名。
2、Python严格区分大小写,变量名、函数名等若大小写错误,程序将报错。
3、Python中每一行代表一条语句,语句以换行符结束,无需使用;作为语句结束标记。
4、Python对缩进有严格要求,严禁随意添加或修改缩进,否则会导致语法错误。
- 合理的缩进能促使开发者编写更简洁的代码,倾向于将长代码拆分为多个函数,从而减少嵌套层级。
- 缩进的缺点在于
复制-粘贴时容易出错,重构代码时需重新检查粘贴内容的缩进是否正确。
5、若一条语句需跨多行编写,应在行尾使用\作为续行符。
6、Python官方建议每行代码长度不超过80个字符,以保持代码清晰易读。
扩展阅读:
Python中文官方文档地址:https://docs.python.org/zh-cn/3/index.html。关于代码规范,Python官方提供了一系列PEP(Python Enhancement Proposals)文档,其中第8篇专门针对代码格式提出建议,即著名的PEP 8标准。文档地址:https://www.python.org/dev/peps/pep-0008/。
一、注释的作用
使用熟悉语言在代码中提示或解释关键逻辑、功能及思路,能显著提升程序的可读性,而代码可读性至关重要。
代码注释效果对比如下图所示:
未添加注释的代码示例。

添加注释后的代码示例。

二、注释的分类
Python注释主要分为两类:单行注释和多行注释。
单行注释
符号#用于单行注释,仅能注释一行内容,具体语法如下:
# 注释内容
多行注释
多行注释可用于注释多行内容,常用于为Python函数、类或模块添加功能描述、版本号及作者信息,具体语法如下:
#写法一:一对三双引号
"""
第一行注释
第二行注释
第三行注释
"""
#写法二:一对三单引号
'''
注释1
注释2
注释3
'''
三、注释的注意事项
Python解释器(Python Interpreter)在执行程序时会忽略注释部分,不进行任何处理。当解释器解析Python文件时,一旦遇到#,即认为#右侧的所有文字均为说明性文字,解释器会直接跳过该行,继续解释下一行代码。
对于极简单的注释,可置于单行代码末尾,通常习惯在代码后添加两个空格,再书写注释文字。
print('hello Python') # 输出
#号与后续注释内容之间需保留一个空格,这虽非强制要求,但属于推荐规范。
Python多行注释不支持嵌套,以下写法为错误示例:
'''
外层注释
'''
内层注释
'''
'''
多行注释符号'''或"""也可作为字符串的开始和结束标记。当多行注释符号作为字符串的一部分出现时,应视为字符串内容而非注释标记,具体示例如下:
#方式一
print("hello world ! hello python !")
print('hello world !')
print("""真香""")
print('''是真的''')
#方式二
str1 = "hello world ! hello python !"
str2 = 'hello world !'
str3 = """真香"""
str4 = '''是真的'''
print(str1)
print(str2)
print(str3)
print(str4)
"""
#执行结果都是
hello world ! hello python !
hello world !
真香
是真的
"""
四、何时使用注释
- 注释并非越多越好,对于逻辑清晰、一目了然的代码,无需添加额外注释。
- 对于复杂操作,应在操作开始前添加若干行注释,说明整体思路。
- 切勿仅描述代码表面逻辑,应假设阅读者具备Python基础知识,注释应侧重于功能性描述。
在正规开发团队中,通常实行代码审核制度,团队成员需相互阅读和理解彼此代码。
五、总结
编写注释是程序员必备的良好编程习惯。
注释主要具备两个作用:
- 说明代码逻辑与功能。
- 辅助调试程序。
注释快捷键
- 单行注释:使用
ctrl + /快捷键。 - 多行注释:无直接快捷键,需选中多行代码后使用
ctrl + /进行批量注释。
本文介绍了Python基础中注释的用法,更多Python相关内容可搜索本站往期文章或继续浏览后续文章,感谢支持!
免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。









