写代码时需要注意的问题及如何做好编程-CSDN博客

本文链接：https://blog.csdn.net/CHENWENFEIc/article/details/140293089

说在前面

新手写代码一定要养成良好的代码风格，编程是一项需要精细和逻辑思维的工作。尽管每个人的编程风格可能不同，但一些普遍的注意事项和方法可以帮助你写出高质量的代码。本文结合我实际代码实例，总结了写代码时需要注意的一些关键点以及如何做好编程的建议，希望对编程初学者有所帮助。

一、代码写作时需要注意的问题

变量初始化

问题：未正确初始化变量可能导致程序行为异常或崩溃。
建议：在使用变量之前确保其已经初始化。特别是数组或指针等。

实例：

int main() {
    int n = 0;
    int m = 0;
    scanf("%d %d", &n, &m);
    int arr1[1000] = {0};
    int arr2[1000] = {0};
    int i = 0;
    for (i = 0; i < n; i++) {
        scanf("%d", &arr1[i]);
    }
    for (i = 0; i < m; i++) {
        scanf("%d", &arr2[i]);
    }
    // Ensure i is initialized to 0 before reusing in while loop
    i = 0;
    // ...rest of the code
}

边界条件检查

问题：忽略边界条件会导致数组越界或死循环等问题。
建议：在循环和条件判断中，尤其注意边界条件的处理。例如：for循环中的起始和结束条件。

实例：

int main() {
    int n = 0;
    scanf("%d", &n);
    int arr[50] = {0};
    int i = 0;
    for (i = 0; i < n; i++) {
        scanf("%d", &arr[i]);
    }
    int flag1 = 0;
    int flag2 = 0;
    for (i = 0; i < n - 1; i++) {
        if (arr[i] < arr[i + 1]) {
            flag1 = 1;
        } else if (arr[i] > arr[i + 1]) {
            flag2 = 1;
        }
    }
    if (flag1 + flag2 == 2) {
        printf("unsorted\n");
    } else {
        printf("sorted\n");
    }
    return 0;
}

正确使用数据类型
- 问题：使用错误的数据类型可能导致数据溢出或精度丢失。
- 建议：选择适当的数据类型，并注意类型转换时可能引起的问题。
- 实例：
```
char* my_strcpy(char* str1, const char* str2) {
    assert(str2 != NULL);
    char* ret = str1;
    while ((*str1++ = *str2++) != '\0') {
        ;
    }
    return ret;
}
```

内存管理

问题：内存泄漏或非法访问会导致程序崩溃。
建议：动态内存分配后记得释放，使用指针时确保指向合法内存区域。

实例：

// In the context of using arrays and avoiding out-of-bounds access
int main() {
    int n = 0;
    scanf("%d", &n);
    int arr[n][n];
    int i = 0, j = 0;
    for (i = 0; i < n; i++) {
        for (j = 0; j < n; j++) {
            scanf("%d", &arr[i][j]);
        }
    }
    int is_upper_triangular = 1;
    for (i = 1; i < n && is_upper_triangular; i++) {
        for (j = 0; j < i; j++) {
            if (arr[i][j] != 0) {
                is_upper_triangular = 0;
                break;
            }
        }
    }
    if (is_upper_triangular) {
        printf("YES\n");
    } else {
        printf("NO\n");
    }
    return 0;
}

代码注释

问题：缺乏注释会使代码难以理解和维护。
建议：在关键部分添加注释，解释代码的功能和逻辑。

实例：

int main() {
    // Input number of elements in each array
    int n = 0, m = 0;
    scanf("%d %d", &n, &m);
    
    // Declare arrays and read elements
    int arr1[1000] = {0}, arr2[1000] = {0};
    int i = 0, j = 0;
    for (i = 0; i < n; i++) {
        scanf("%d", &arr1[i]);
    }
    for (j = 0; j < m; j++) {
        scanf("%d", &arr2[j]);
    }
    
    // Merge arrays while maintaining sorted order
    i = 0, j = 0;
    while (i < n && j < m) {
        if (arr1[i] < arr2[j]) {
            printf("%d ", arr1[i++]);
        } else {
            printf("%d ", arr2[j++]);
        }
    }
    while (i < n) {
        printf("%d ", arr1[i++]);
    }
    while (j < m) {
        printf("%d ", arr2[j++]);
    }
    
    return 0;
}

调试和测试

问题：未充分调试和测试的代码容易出现隐藏的错误。
建议：充分利用调试工具和测试框架，逐步测试每个模块。

实例：

// 检查数组是否已排序的测试用例示例
int main() {
    int n = 0;
    scanf("%d", &n);
    int arr[50] = {0};
    for (int i = 0; i < n; i++) {
        scanf("%d", &arr[i]);
    }
    // 测试排序数组
    for (int i = 0; i < n - 1; i++) {
        assert(arr[i] <= arr[i + 1]);
    }
    return 0;
}

代码结构和可读性

问题：混乱的代码结构会降低代码可读性，增加维护难度。
建议：保持代码整洁，使用合适的缩进和命名规范，模块化设计。

实例：

// 用于合并两个排序数组的结构化且可读的代码
void merge_sorted_arrays(int* arr1, int n, int* arr2, int m) {
    int i = 0, j = 0;
    while (i < n && j < m) {
        if (arr1[i] < arr2[j]) {
            printf("%d ", arr1[i++]);
        } else {
            printf("%d ", arr2[j++]);
        }
    }
    while (i < n) {
        printf("%d ", arr1[i++]);
    }
    while (j < m) {
        printf("%d ", arr2[j++]);
    }
}

int main() {
    int n = 0, m = 0;
    scanf("%d %d", &n, &m);
    int arr1[1000] = {0}, arr2[1000] = {0};
    for (int i = 0; i < n; i++) {
        scanf("%d", &arr1[i]);
    }
    for (int j = 0; j < m; j++) {
        scanf("%d", &arr2[j]);
    }
    merge_sorted_arrays(arr1, n, arr2, m);
    return 0;
}