180代码规范

编程规范与调试技巧

原创已于 2023-04-27 09:43:03 修改 · 169 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#代码规范

于 2023-04-27 08:25:31 首次发布

文章提出了几点编程实践中提升代码可读性和易维护性的建议，包括变量和函数命名规则，如首字母大写，使用英文全称或加注释的简称，以及将复杂条件判断抽象为独立函数来简化逻辑。同时强调了添加注释的重要性，尤其在团队协作中。

为了让大家在自己编码以及互debug的时候能够做到形式统一、风格相似，我试着总结了几点比较好用的tips。

1.每个人自己的主函数（不一定是main，更多是指相对于自己的）里面的变量首字母要大写。

2.自己声明的结构体、类以及类中变量需要首字母大写。

struct BstNode {
	int Key;
	BstNode* Left;
	BstNode* Right;
	BstNode(int k) { Key = k; Left = Right = NULL; }
};

3.除了部分循环中的ijk这种临时变量，其余变量能用英文单词全称就用英文单词全称，太长用简称并且加注释。

4.对于每个函数，首字母大写的全称英文单词做函数名，多个单词罗列多个单词大写；参数小写。（补：函数名前加上大写姓名缩写，下划线链接。）

void CYM_Insert(BstNode* &t, int k)；
int CYM_GetMin(int a, int b)；
int CYM_GetDistance(string a, string b)；

5.除非能保证这块代码不会给其他任何人看且不会出bug，一定要加注释。

6.这次课设不可避免的要大量接触条件判断。当我们遇到很复杂的条件判断时，可以尝试抽象出对每个对象的条件判断，为其单独写判断函数，这样能大量简化if。

//pta第六周b题条件判断就极为繁杂
bool Eagle(int i){
    return i!=0&&i!=INF;
}

if(Eagle(D[i][k])&& Eagle(D[k][j]))；

//如果是普通写法，那么我们的条件判断中将是四个条件罗列，容易搞混。于是抽象出合法这个概念，当参数不等于零且不等于正无穷时合法，这样再看条件判断就是两个数合法就可以进入if，非常方便后期debug

7.未完待续