【编程系列】编程规范之文件头和函数头格式

DATE: 2019-6-26

---

前言

    编程规范是指采用编程语言进行程序设计和开发时，采用一种规范的格式，包括注释、说明、编程格式以及风格等。不同的程序员具有不同的编程风格，良好的编程风格和编程规范对于程序阅读和理解具有很大的帮助。本文主要总结了在编程实践中的一些比较好的编程风格和规范。

1、源文件头格式

/******************************************************************
/*    xxx  xxx CO. LTD
/*    2010-2019 Copyright reversed
/*    File:  encode.c
/*    Function: this file used to encode source yuv file into h264 stream 
/*    Author: SoaringLee
/*    Modified:2019.6.29 Created
/********************************************************************/

2、函数声明头格式

/******************************************************************
/*    xxx  xxx CO. LTD
/*    2010-2019 Copyright reversed
/*    Declaration :  int streamread(void *ptr, int length)
/*    Function: read and parse stream
/*    Parameters:
/*         @Input:
/*            ptr: pointer to the stream
/*            length: stream length
/*         @Output:
/*            return
/*    Author: SoaringLee
/*    Modified:2019.6.29 Created
/********************************************************************/

---

THE END!