python代码文件头注释规范

说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。

文件头注释规范格式,如下:

# -*- coding: utf-8 -*- #

# ------------------------------------------------------------------
# File Name:        pyxxx
# Author:           sacevan
# Version:          ver0_1
# Created:          2020/12/15
# Description:      Main Function:    按日增量清洗用户上课日志
#                   Outer Parameters: date_key  eg: 20201215
# Function List:    exit() -- exit the interpreter by raising SystemExit
#                   getdlopenflags() -- returns flags to be used for dlopen() calls
#                   getprofile() -- get the global profiling function
# History:
#       <author>        <version>       <time>      <desc>
#       sacevan         ver0_1          2020/12/15  xxx
# ------------------------------------------------------------------

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值