【嵌入式】ChipON IDE编程格式

C文件头模板

/**
* @file:KeyFunction.c
* @copyright:Copyright 2020-2021 SGMW. Co. Ltd. AllRights Reserved.
* @brief:按键模块
* @detail:涉及按键识别，以及按键按下后对应某参数的状态改变
* @author:XXX
* @date:2020-05-18
* @version:版本
* @record:修改记录
* XXX于2020-05-18创建
* XXX于202X-XX-XX修改了XXX
*/

 

函数说明
prototype： 函数名称
brief：　　　简要说明
detail：　　 详细说明
param：　　参数说明，in表示参数输入（值用来判断或者赋值给别人，没有改变它的值）；
　　　　　　out表示参数输出（其值在 函数中被改变了，且外部函数会用到其值）；
　　　　　　inout表示参数即做输入输出
return：        返回值名称，类型
retval ：　　返回值
par：　　　 修改日志

/**
*@prototype:
*@brief:
*@detail:
*@param[in|out|inout]:参数1 参数1说明
*@param[in|out|inout]:参数2 参数2说明
*@return:
*@retval  返回值
*par        修改日志
*- YYYY-MM-DD,首次创建，xxx
*/

 

代码排版规范：
1. 程序块采用缩进风格编写，每级缩进为4个空格

2. 相对独立的程序块之间、变量说明之后必须加上空行
3. 多个短语句不允许同时出现在同一行内，即一行只写一条语句
4. if、for、do、while、case、switch、default等语句独占一行，执行语句还要使用{ }括起来
5. 非单目操作符前后要加空格： 如向量地址递增就是单目p++，p与++不能有空格，参数赋值就是非单目，flag = 0；flag与=，=与0之间需加空格

 

注释：

1. 在处理逻辑代码中，源代码有效性注释量必须在30%以上
2. 在代码的功能、意图层次进行注释

3. 修改代码时，维护代码周边的所以注释，以保证注释和代码的一致性，不再使用的的注释要删除

4. 对变量的定义和分支语句必须编写注释
5. 禁止在一行代码或者表达式中间插入注释
6. 相对独立、有特定功能程序块，要加注释说明其作用
7. 注释统一用： ///<