Python的代码注释标准模版
ling_yun upravil tuto stránku před 1 rokem

Python的代码注释大致分为两种:单行注释#、多行注释三个(单引号 '''/双引号""")

下面开始举例说明:

例1.

# 这是一个单行注释,通常用在代码内部,用来说明单行或代码块的作用

例2.


"""

这是一个文档字符串

用于描述函数的功能和行为

"""

接下来描述函数功能的注释如何编写:

"""

Description :尝试将文件从源路径剪切到目标路径。(此行代表改代码的作用描述)
@Author ly(作者名称)
@Date 2024/12/16 11:13(最后一次修改日期,为了防止忘记什么时候编写的代码)
@Version 1.0(版本号,稳定版本为奇数,测试版本为偶数,当变动过大时,可在小数点前加1)
@param sourcePath 源文件路径(param代表需要输入的参数,有几个参数写几个,没有就不写)
@param targetPath 目标文件路径
@return 如果剪切成功返回true,否则返回false(return代表返回类型,没有就不写)

"""