1.注释作用
注释的最大作用是提高程序的可读性,向用户提示或解释某些代码的作用和功能 在调试(Debug)程序的过程中,注释可以用来临时移除无用的代码 一般情况下,合理的代码注释应该占源代码的 1/3 左右
2.注释分类
单行注释:从井号# 开始,直到这行结束为止的所有内容都是注释 # 注释内容 多行注释:通常用来为 Python 文件、模块、类或者函数等添加版权或者功能描述信息
3.注释示例
# -*- coding: utf-8 -*-
# @Date : 2018-10-30
# @Author : Peng Shiyu
"""
这个文档注释pydoc的示例
"""
# 函数名上方的文字
def func():
"""
函数名下方的注释
@return: None
"""
print("hello")
# 类名上方的文字
class Demo():
"""
类名下方的文字
"""
# 类中方法上方的文字
def hello(self):
"""
类中方法下方的文字
@return: None
"""
print("hello")
4.缩进
Python 中实现对代码的缩进,可以使用空格或者 Tab 键实现。但无论是手动敲空格,还是使用 Tab 键,通常情况下都是采用 4 个空格长度作为一个缩进量
对于类定义、函数定义、流程控制语句、异常处理语句等,行尾的冒号和下一行的缩进,表示下一个代码块的开始,而缩进的结束则表示此代码块的结束
本文系转载,前往查看
如有侵权,请联系 cloudcommunity@tencent.com 删除。
本文系转载,前往查看
如有侵权,请联系 cloudcommunity@tencent.com 删除。