0. 概念
- 一段文字性的
描述
1. 特性
- 当程序
被处理
的时候,注释会被自动忽略
,不会被当做代码处理
2. 应用场景
- 帮助开发人员理清
代码逻辑
- 帮助开发人员进行
代码调试
- 减少开发人员之间的
沟通成本
- 方便开发人员生成
项目文档
3. 分类
- 单行注释:
#
- 多行注释:
''' 注释信息 '''
和""" 注释信息 """
- 特殊注释
-
#!/usr/bin/env python
:只在Linux
系统下生效,调用当前系统
环境变量的Python
-
# _*_coding:utf-8_*_
:解决Python2.x
中中文乱码
问题
-
4. 规范
- 函数
1. 形式:直接在函数体的最上面,添加三个双引号对注释 def 函数名(): """ 注释信息 """ 2. 注释信息 (1) 函数功能 (2) 参数 1) 含义 2) 类型 3) 是否可以省略 4) 默认值 (3) 返回值 1) 含义 2) 类型 3. 示例 def calculate(a, b=1): """ 计算两个数据的和, 以及差 :param a: 数值1, 数值类型, 不可选, 没有默认值 :param b: 数值2, 数值类型, 可选, 默认值: 1 :return: 计算结果, 元组: (和,差) """ value = a + b number = a - b return (value, number)
- 类
1. 形式 (1) 直接在类的下方, 使用三个双引号对注释 (2) 需要注明类的作用, 以及类属性描述 (3) 方法注释和函数注释一样 2. 示例 class Person: """ 关于这个类的描述, 类的作用, 类构造函数, 类属性等等 Attributes: count: int 代表人的个数 """ count = 100 def play(self, ball): """ 这个方法的作用效果 :param ball: 参数含义, 参数类型, 是否可选, 是否有默认值 :return: 返回结果含义, 返回结果数据类型 """
- 模块
网友评论