[Python知识库]Python 个人对代码注释的书写习惯

为了养成良好的代码书写规范，笔者决定以后都按照一种常用的代码注释风格。

1、文件头

文件头一般包含文件的创作者、功能、历史版本等信息，希望自己以后可以按照如下简洁的风格书写 Python 文件头

# -*- coding: utf-8 -*- #
# ------------------------------------------------------------------
# File Name:        pyxxx
# Author:           hlgou
# Version:          V 1.0
# Created:          2020/12/15
# Description:      the main function of the file
# History:
#          2021-09-20   hlgou       :Create the file
#          2021-xx-xx   xxxxxxxx    :Do some modified
# ------------------------------------------------------------------

2、函数

功能简单的函数，只需在函数前加一行注释，说明函数的功能。

""" Util: append Time and xyz in Data """
def append2Data(time,pos1):

功能复杂的函数，需要说明函数的功能、传入传出参数的含义

"""
This is the description of the function.
 
> @param[in] param1:        this is the first param
> @param[in] param2:        this is the second param
return: 
< @param[out] outParam1:    this is the first out param
< @param[out] outParam2:    this is the second out param
"""
def append2Data(time,pos1):