python注释规范
功能要求
为Python代码添加注释，对Python程序代码进行说明。
实例代码
'''多行注释开始
下面的代码根据变量x的值计算y
注意代码中使用缩进表示代码块
多行注释结束'''
x = 5
if x > 100:
y = x * 5 - 1 # 单行注释：x>100时执行该语句
else:
y = 0 # x <= 100时执行该语句
print(y) # 输出y
运行结果
知识说明
注释用于为程序添加说明性的文字，帮助程序员更好的阅读和理解程序代码。Python解释器会忽略注释的内容，即注释的内容不会被Python解释器执行。
Python注释分为单行注释和多行注释。
单行注释以符号“#”开始，当前行中符号“#”及其后的内容为注释语句。单行注释可以独占一行，也可放在语句末尾。 说明： 在Pycharm中使用“ctrl + /”可以添加/取消单行注释。
多行注释是用3个英文单引号“'''多行注释文本'''”或3个双引号“"""注释文本"""”进行注释。 注意： 由一对三个单引号或一对三个双引号括起来的内容被认为是注释，但不能由三个单引号和三个双引号混合使用。
‘贰’ Python单行注释和多行注释怎么写，需要注意什么
1 单行注释（行注释）
以 # 开头，# 右边的所有东西都被当做说明文字，而不是真正要执行的程序，只起到辅助说明作用,如：
print("hello python") # 输出 `hello python`
注意：为了保证代码的可读性，# 后面建议先添加一个空格，然后再编写相应的说明文字；为了保证代码的可读性，注释和代码之间 至少要有 两个空格。
2 多行注释（块注释）
要在 Python 程序中使用多行注释，可以用 一对 连续的 三个 引号(单引号和双引号都可以)，如：
"""
这是一个多行注释
在多行注释之间，可以写很多很多的内容……
"""
print("hello python")
提示：
注释不是越多越好，对于一目了然的代码，不需要添加注释
对于 复杂的操作，应该在操作开始前写上若干行注释
对于 不是一目了然的代码，应在其行尾添加注释（为了提高可读性，注释应该至少离开代码 2 个空格）
绝不要描述代码，假设阅读代码的人比你更懂 Python，他只是不知道你的代码要做什么 （BY三人行慕课）
‘叁’ python多行注释是什么
python多行注释是：用来向用户提示或解释某些代码的作用和功能，它可以出现在代码中的任何位置。Python 解释器在执行代码时会忽略注释，不做任何处理，就好像它不存在一样。
千万不要认为你自己写的代码规范就可以不加注释，甩给别人一段没有注释的代码是对别人的不尊重，是非常自私的行为；你可以喜欢自虐，但请不要虐待别人。
python学习方法：
很多程序员宁愿自己去开发一个应用，也不愿意去修改别人的代码，没有合理的注释是一个重要的原因。虽然良好的代码可以自成文挡，但我们永远不清楚今后阅读这段代码的人是谁，他是否和你有相同的思路；或者一段时间以后，你自己也不清楚当时写这段代码的目的了。
给代码添加说明是注释的基本作用，除此以外它还有另外一个实用的功能，就是用来调试程序。举个例子，如果你觉得某段代码可能有问题，可以先把这段代码注释Python 解释器忽略这段代。
‘肆’ Python函数注解使用有哪些注意事项呢
函数注解是关于用户自定义的函数的完全可选的、随意的元数据信息。
1.无论 Python 本身或者标准库中都没有使用函数注解；本节只是描述了语法。第三方的项目是自由地为文档，类型检查，以及其它用途选择函数注解。
2.注解是以字典形式存储在函数的 __annotations__ 属性中，对函数的其它部分没有任何影响。参数注解（Parameter annotations）是定义在参数名称的冒号后面，紧随着一个用来表示注解的值得表达式。返回注释（Return annotations）是定义在一个 -> 后面，紧随着一个表达式，在冒号与 -> 之间。下面的示例包含一个位置参数，一个关键字参数，和没有意义的返回值注释:
>>> def f(ham: 42, eggs: int = 'spam') -> "Nothing to see here":
... print("Annotations:", f.__annotations__)
... print("Arguments:", ham, eggs)
...
>>> f('wonderful')
Annotations: {'eggs':
, 'return': 'Nothing to see here', 'ham': 42}
Arguments: wonderful spam
‘伍’ python的基本语法是什么
语法规则，条件语句、循环语句、方法、类那些。基本内数据类型，Python是弱类型需要容，但还是有类型的，这些类型的特点及操作。内置库API的使用，比如sqlite、网络请求库、json等。
Python由荷兰数学和计算机科学研究学会的Guido van Rossum于1990 年代初设计，作为一门叫做ABC语言的替代品。
Python提供了高效的高级数据结构，还能简单有效地面向对象编程。Python语法和动态类型，以及解释型语言的本质，使它成为多数平台上写脚本和快速开发应用的编程语言，随着版本的不断更新和语言新功能的添加，逐渐被用于独立的、大型项目的开发。
Python解释器易于扩展，可以使用C或C++（或者其他可以通过C调用的语言）扩展新的功能和数据类型。 Python 也可用于可定制化软件中的扩展程序语言。Python丰富的标准库，提供了适用于各个主要系统平台的源码或机器码。
2021年10月，语言流行指数的编译器Tiobe将Python加冕为最受欢迎的编程语言，20年来首次将其置于Java、C和JavaScript之上。
‘陆’ python代码为什么有下划波浪线
python代码的注释下面带波浪线的问题：
python代码的注释格式应该是#空格注释，否则注释下面就会带有波浪线，虽然不加空格也不影响程序运行，但是不符合注释规范。
python编辑器pycharm代码有下划波浪线：
解决方法：
点击file--settinng，找到Inspections，取消勾选右侧python：
更多Python知识请关注Python自学网。
‘柒’ python注释规范
确保对模块, 函数, 方法和行内注释使用正确的风格
参考：Python风格规范 — Google 开源项目风格指南
文档字符串
模块
函数和方法
Args :
Returns: (或者 Yields: 用于生成器)
Raises:
类
块注释和行注释
‘捌’ Python教程：单行多行注释
工具/材料
python
- 01
在python中使用#号表示单行注释
- 02
使用""" """或''' '''做为多行注释
- 03
单行注释和多行注释不宜过多,不是每行代表都要注释,最好用来解释函数的操作
- 04
以下是一些错误使用注释的方式,一些能直接看到结果的代码最好不要多写注释
特别提示
关键代码,复杂代码使用注释