1.有关注释
书写函数或者代码的时候,需要写注释
eg:
/*!
* @brief 基于soble边沿检测算子的一种边沿检测(简介)
*
* @param imageIn 输入数组
* imageOut 输出数组 保存的二值化后的边沿信息 (形参,输入量)
* Threshold 阈值
*
* @return (返回值)
*
* @note (注意事项)
*
* @example (例子)
*
* @date 2020/5/15 (更新时间)
*/
2.有关全局变量
对于变量,不同代码部分的变量可以写成结构体形式
eg:
typedef struct {
int a;
float b;
} camera;
这样的书写格式便于阅读与区分;
3.有关头文件
可以建一个 #include “include.h” 来存储全部的头文件,并且注释好;