C 注释编写模版

编写清晰、有用的注释是提高代码可读性和可维护性的关键。良好的注释不仅能帮助他人理解您的代码，也能在未来您自己或其他开发者需要维护或扩展代码时节省大量时间。下面提供了一些常见的注释模板和最佳实践，适用于不同的编程语言和场景。

头部文件注释：用于描述文件的用途、作者信息、版本历史等

/*
 * 文件名: main.cpp
 * 描述: 这个文件包含了飞机大战游戏的主要逻辑实现。
 * 作者: 张三
 * 创建日期: 2025-03-02
 * 版本: 1.0
 */

函数方法：注释

解释函数的目的、参数、返回值及其可能抛出的异常

第一种方式

/* 
* 函数介绍：
* 输入参数：
* 输出参数：
* 返回值 ：
*/ 

第二种方式

/**
 * 计算两个数的最大公约数（GCD）。
 *
 * @param a 第一个整数
 * @param b 第二个整数
 * @return 两个数的最大公约数
 * @throws IllegalArgumentException 如果任一参数小于等于0
 */
public static int gcd(int a, int b) throws IllegalArgumentException {
    if (a <= 0 || b <= 0) throw new IllegalArgumentException("参数必须大于0");
    while (b != 0) {
        int temp = b;
        b = a % b;
        a = temp;
    }
    return a;
}

行注释

void Func1(int x, int y, int z); // 良好的代码风格
void Func1 (int x,int y,int z);  // 不良的代码风格

// 良好的注释风格
int width;  // 宽度
int height; // 高度
int depth;  // 深度

// 不良的注释风格
int width;    // 宽度
int height;       // 高度
int depth;  // 深度