《C注释amp;标签规则》.docx

C CODE标签和注释规约 注释要求简单，符合Doxygen文档生成规范，注释位于需要注释的上方，注释要求统一使用简洁的英文，语法方面不严格要求，但必须语义清楚明了。 新增文件标签注释格式 行最大120个字符 头文件部分(.h文件) /********************************************************************************************************************* * @file atomic.h * @brief describe the chief function of this file, simply . 头文件版本申明块 * @version 1.0 * @date * @author Design : SunLiuYing后续队文件的修改，增加标记 * @author Code : SunLiuYing * @author Modify : YuFengnothing * @copr Tag : /********************************************************************************************************************* 间隔两行，以下每部分之间间隔都是两行 预编译开始部分 #ifndef _ATOMIC_H_ #define _ATOMIC_H_ 间隔两行 #include stdio.h 引用系统头文件部分，先系统后自己，之间用一行分开，其他一些符号也也定义在这里 #include stdlib.h 引用自己模块定义的头文件 #include test.h 间隔两行 #ifdef __cplusplus extern C { #endif 文件中宏定义、变量、结构体定义的注释格式 /** 功能说 明 */ */ /** the max value of the global spin lock array */ #define MAX_SPIN_LOCK 100 /** spin_lock structure definition */ struct spin_lock Struct结构体里注释部分要对齐 { unsigned int lock_data; /* lock data */ unsigned int pad[7]; /* pad [7] store the pad informatio */ unsigned int reserved[10]; /* reserved information2 */ }; /** type define spin_lock_t as struct spin_lock 函数的注释采用和变量注释一样，只是增加相关入参，出参、返回值、功能的说明,对于简单的函数只需 简单说明函数功能即可。不需要param、return、note说明,[in][out]表示是输入还是输出参数 */ typedef struct spin_lock *spin_lock_t; /** * compare store value and get store value * @param[in] unsigned int oval * @param[in] unsigned int nval * @param[in|out] unsigned int *area * @return unsigned int * @note should be called before use the spin_lock_t */ extern unsigned int compare_and_store(unsigned int oval, unsigned int nval, unsigned int *area); 间隔两行 #endif /* _ATOMIC_H_ */ 实现文件部分(.c文件) /********************************************************************************************************************* * @file