浅析如何写出高质量代码

目录

1.我们为什么需要写出高质量的代码

2.高质量代码所具备特征

3.以模拟实现c语言中的库函数为示例分析

  1.我们为什么需要写高质量代码

  谈到高质量的代码，可能很多新人包括我自己第一次听到这个概念时多少有些一头雾水。而实际上代码写出来不仅仅是满足能运行的要求即可，更应该有较好的可读性与可维护性等性质。或许新人们可能不理解为什么要这样？而其实在往后的面试或者工作中，一串高质量代码往往比一堆山一般的代码要更能打动面试官，同事也会更乐意与你合作，而不是看见你的代码就”嗡“的一声头大。

  2. 高质量代码所具备的特征

1：代码运行正常（最基本）

2：很少或者没有bug

3：效率高（算法方面的优化）

4：可读性强（没有人包括你自己会乐意看见一堆无厘头的代码）

5：可维护性高（便于与同事对接或者后期维护）

6：注释清晰（不要自己都看不懂了）

7：规范的命名（如a,b,c之类的就是反例）

  3.模拟实现strcpy函数

  前面已经讲了那么多，但是光说不练假把式，接下来我们就以c语言中的strcpy库函数实现为例子，看看我们是如何在编程中贯彻这些思想的。

  首先，我们先简单介绍一下strcpy函数的作用：strcpy的作用可以简单理解为将一个字符串复制到另一个地址空间（注：'\0'也会被一同复制）。下面我们来看一看strcpy的运用效果。测试代码如下。

#include<stdio.h>
#include<string.h>
int main()
{
	char a1[] = "hello ";
	char a2[] = "world ";
	printf("%s", a1);//打印复制前的字符串
	printf("%s", a2);
	printf("\n");
	strcpy(a1, a2);
	printf("%s", a1);//复制后
	printf("%s", a2);
	return 0;
}

实际效果如下：

 看到这里，我想很多读者应该很快就能想到利用指针来实现这个strcpy函数，于是，很快啊，得到了如下的代码。

void my_strcpy(char* dest, char* src)
{
	while (*src != '\0')
	{
		*dest = *src;
		dest++;
		src++;
	}
	*dest = *src;//处理'\0'
}

这串代码能运行吗？当然能。但他写得好吗？假如我是个面试官，或许它只能得5分。

它的优势：能够运行并且没有严重bug，可读性及变量命名较好

劣势：代码略显冗余，调用不太方便（指不支持链式访问）

printf("%s",strcpy(arr1,arr2));//链式访问示例

有了上述的分析，我们可以得到下面的my_strcpy 2.0版本

char* my_strcpy(char* dest, char* src)
{
	char* begin = dest;//存储原地址
	while (*begin++ =* src++);//执行字符串拷贝直到遇到'\0'
	return dest;//返回目的地址
}

可以看到，2.0版本的代码相对上一版无论是简洁性还是易用性（此处指支持链式访问）都有了提升。如果我是面试官，那么这串代码我可能会给你7分，为什么呢？因为他的鲁棒性（健壮性）不够，通俗的说就是这串代码在遭遇异常状况时的处理能力。

  比如遭遇以下情况时：

#include<stdio.h>
#include<string.h>
#include<assert.h>
char* my_strcpy(char* dest,char* src)
{
	char* begin = dest;
	while (*begin++ =* src++);
	return dest;
}

int main()
{
	char a1[] = "hello ";
	char a2[] = "world ";
	printf("%s", a1);
	printf("%s", a2);
	printf("\n");
	my_strcpy(NULL, a2);//传入空指针
	printf("%s", a1);
	printf("%s", a2);
	return 0;
}

这次我们向函数内传入了一个空指针，这次我们的运行结果会是怎么样的呢。

 可以看到，传入空指针后我们的strcpy函数似乎并未执行，但是代码却似乎正常运行了，这对于我们日后的代码维护是极为不利的，于是我们引入assert（断言函数，需要assert.h头文件）。

  或者我们在编写函数时也可能会有如下情况发生

#include<string.h>
#include<stdio.h>
#include<assert.h>
char* my_strcpy(char* dest, char* src)
{
	char* begin = dest;
	while (*src++ =* dest++);//注意这里两个指针写反了
	return dest;
}

int main()
{
	char a1[] = "hello ";
	char a2[] = "world ";
	printf("%s", a1);
	printf("%s", a2);
	printf("\n");
	my_strcpy(a1, a2);
	printf("%s", a1);
	printf("%s", a2);
	return 0;
}

这里我们有可能出现不小心就将函数内部的指针写反，而此次运行结果如下。

 虽然该程序能够正常运行，但是可以看到结果明显是错误的，而针对这种错误如果我们不去认真调试那将是非常难发现的，那么为了有效避免这种情况发生，我们会用到const函数。

  经过上述的分析，我们得到最终版的代码如下。

#include<string.h>
#include<stdio.h>
#include<assert.h>
char* my_strcpy(char* dest,const char* src)//降低代码bug率
{
	assert(dest && src);//如果条件为假程序会报错（信息详细便于调试）
	char* begin = dest;
	while (*dest++ =* src++);
	return begin;
}

int main()
{
	char a1[] = "hello ";
	char a2[] = "world ";
	printf("%s", a1);
	printf("%s", a2);
	printf("\n");
	my_strcpy(a1, a2);
	printf("%s", a1);
	printf("%s", a2);
	return 0;
}

assert函数的使用可以有效避免NULL空指针等错误的参数的传入，const函数也能一定程度上降低我们写出bug的概率，从而提升程序的稳定性，如果面试官见到你写出了这样的代码，那么他很有可能对你的印象瞬间就提升了不少。满分10分的话我给9分，少给一分怕你骄傲（dog）。

  最后我们再简单谈一谈const函数的使用方法：

const修饰指针变量时

1. const如果放在*的左边，修饰的是指针指向的内容，保证指针指向的内容不能通过指针来改 变。但是指针变量本身的内容可变。

2. const如果放在*的右边，修饰的是指针变量本身，保证了指针变量的内容不能修改，但是指 针指向的内容，可以通过指针改变。

  本文到此结束，作者能力有限，本文出现的纰漏还请大家批评指正

更正2021.11.29：感谢@司徒山不指出my_strcpy函数最终版本return的错误，现已更正