- 头文件说明及格式
/** * @file mySList.h * @brief 顺序表头文件 * @details 定义了函数返类型status、函数结果状态代码、宏常量 * @details 定义了操作函数类型:myOpFunType * @details 定义了元素类型etype * @details 定义了顺序表结构体mySList,及顺序表常用函数的实现 */ #ifndef __mySList_H__ #define __mySList_H__ #define _CRT_SECURE_NO_WARNINGS #include<cstdio> #include<cstdlib> #include<cstring> #include<cassert> 具体的代码及注释 #endif // !__mySList_H__
- 函数返回类型status,函数结果状态代码,宏常量
/** * @brief 定义函数返回值类型:int: \n * @retval - OK(1):操作成功 * @retval - ERROR(-1):错误,不可操作 * @retval - TRUE(1):真 * @retval - FALSE(0):假 * @retval - OVERFLOW(-2):内存溢出 * @retval - ERR_PARA(-3):参数不符合要求 */ typedef int status; // OK:表示操作成功 #define OK 1 // ERROR:表示某结构不存在 #define ERROR -1 // TRUE:表示真 #define TRUE 1 // FALSE:表示假 #define FALSE 0 // OVERFLOW:内存溢出 #define OVERFLOW -2 // ERR_PARA:传入实参值不符合要求 #define ERR_PARA -3 // CAPACITY:初始容量 #define CAPACITY 10 // DOUBLE:一个倍数 #define DOUBLE 1.3