C++项目注释规范

本良好的注释规范可以提高代码的可读性和可维护性，文主要记录开发过程中个人针对日志记录实战成果，推荐使Doxygen风格标签：

- @brief - 简要描述
- @details - 详细描述
- @param - 函数参数
- @return - 返回值
- @note - 注意事项
- @warning - 警告信息
- @see - 参考链接
- @code - 代码示例开始
- @endcode - 代码示例结束

1.头文件注释

每个源文件开头应包含文件头注释，说明文件的基本信息：

/**
 * @file    filename.cpp
 * @brief   简要描述文件功能
 * @author  作者名
 * @date    创建日期
 * @version 版本号
 * 
 * 详细描述文件功能和内容
 */

#ifndef NMS_SERVER_H_H

#define NMS_SERVER_H_H

#endif

2.函数注释

/**
 * @brief   函数简要描述
 * 
 * @param   param1 参数1的描述
 * @param   param2 参数2的描述
 * @return  返回值描述
 * 
 * @note    注意事项或特殊说明
 * @example 使用示例
 */

int functionName(int param1, float param2) {

    // 函数体

}

3.类注释

/**
 * @class   ClassName
 * @brief   类的简要描述
 * 
 * 类的详细描述，包括主要功能、设计思路等
 */

class ClassName {

    // 类成员

};

4.行内注释

// 单行注释，在代码行上方或右侧
int var = 0;  // 说明变量用途

/*
 * 多行注释，用于复杂逻辑说明
 * 第二行说明
 */

#### 5.特殊标记

// TODO: 需要实现的功能

// FIXME: 已知问题需要修复

// XXX: 需要特别注意的代码

// HACK: 临时解决方案