搜索
您的当前位置:首页正文

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
# ------------------------------------------------------------------

 

因篇幅问题不能全部显示,请点此查看更多更全内容

Top