c语言vscode注释模板

### C语言代码文档注释模板

对于C语言，在VSCode中编写良好的代码文档注释有助于提高代码可读性和维护性。通常采用Doxygen风格的注释来支持自动生成API文档工具。

#### 函数声明前的注释

/**
 * @brief 计算两个整数的最大公约数.
 *
 * 使用欧几里得算法计算给定两个正整数值的最大公约数。
 *
 * @param a 第一个输入参数，表示第一个整数.
 * @param b 第二个输入参数，表示第二个整数.
 * @return 返回a和b的最大公约数.
 */
int gcd(int a, int b);

#### 变量定义处的注释

/* 
 * 定义全局变量用于存储程序运行状态码,
 * 0 表示成功；非零值代表不同类型的错误情况.
 */
extern int program_status;

#### 文件头部信息

/*
 ******************************************************************************
 * File Name     : math_operations.c
 * Description   : 提供基本数学运算功能实现.
 * Author        : John Doe <john.doe@example.com>
 * Date          : 2023-10-09
 * Version       : V1.0.0
 ******************************************************************************
*/

为了使这些注释更加高效地工作并能被像Doxygen这样的工具解析，建议安装相应的VSCode插件以提供语法高亮和支持[^1]。