关于C程序注释规范V1

关于C程序注释规范

作者：@LLL

2018-5-30 

  同一项目开发中，尽量保持代码注释规范和统一。

  注释方便了代码的阅读和维护。

  边写代码边注释， 修改代码时要相应修改注释， 保证注释和代码的一致性。

  注释要简洁明确，不要出现形容词。

  对于写的好的注释，我们将是第一个受益者。

  项目开发中，通过注释可以快速知道他人所写函数的功能，返回值，参数的使用。

一：头文件（.h）

1头文件描述

/*

@file    文件名

@Author: 作者

@version V3.5.0

@Date: 2013/8/6 14:34

@brief：  文件的描述、定义变量、常量、函数

*/

 

 

2头文件函数描述

/*

//@brief：

*/

二：.c文件

1.   .c文件描述

/*

@Hareware_Link:

      例：LED0-DS0 PB5

      LED1-DS1 PE5

*/

2.   函数描述

/*

FunctionName: 函数名

Purpose:目的

Params:参数

Return:int 返回值

Limitation:特殊值描述

*/