如何写出一段好的代码
- 优秀的代码要具备以下条件
- 常见的coding技巧：
- 5分答案
- 6分答案
- 6.5分答案
- 7分答案
- 7.5分答案
- 8分答案
- 9分答案
- 10分答案
- 拓展练习
今天简单来谈谈如何写出一段好的代码
一般来说，我们总要试着写出优秀的代码，有些人调侃为了保证自己的“核心竞争力”要不写注释，多写嵌套，完了之后还bug一堆，写出那些个及其难以调试和让一般人读不懂的代码，这自然是不合理的，调侃毕竟是调侃，一直这样只会受到同事鄙夷的目光~~
那么我们要如何写出优秀的代码呢？
首先推荐阅读《高质量c/c++程序设计指南》
优秀的代码要具备以下条件
- 代码运行正常
- bug很少
- 效率高
- 可读性高
- 可维护性高
- 注释清晰
- 文档齐全
常见的coding技巧：
- 使用assert
- 尽量使用const
- 养成良好的编码风格
- 添加必要的注释
- 避免编码的陷阱
比如说接下来我们来实现一个库函数strcpy
首先来看一下MSDN中库函数strcpy的参数
所以我们需要两个参数，两个指针一个指向复制目标的地址，还有一个指向复制的源
比如说我给出这样的主函数：
int main()
{
//strcpy
char arr1[] = "别复制到我这里";
char arr2[] = "别把我复制过去";
my_strcpy(arr1,arr2);//把arr2 拷贝到 arr1
printf("%s\n",arr1);
return 0;
}
比如说我这样来实现：
5分答案
void my_strcpy(char*dest, char*src)
{
while (*src!='\0')
{
*dest = *src;
src++;
dest++;
}
}
看上去好像没什么问题实际上10分里面只能给5分，不及格，因为这样的代码存在的问题就是当我走到\0的时候并没有把\0给复制过去，所以相当于没有实现我要求的功能，自然是不及格的，所以代码仍然需要改进
6分答案
void my_strcpy(char*dest, char*src)
{
while (*src!='\0')
{
*dest = *src;
src++;
dest++;
}
*dest = *src;//还得把斜杠0搞过去
}
最后把斜杠0搞过去了，以为这样就好了，没有现在只不过刚刚及格，还存在可以优化的地方，可以缩短行数，如下
6.5分答案
void my_strcpy(char*dest, char*src)
{
while (*src != '\0')
{
*dest++ = *src++;
}
*dest = *src;//还得把斜杠0搞过去
}
没错，这个答案将循环体里面的3行代码优化成了一行代码，然而这样的代码还是可以优化
7分答案
void my_strcpy(char*dest, char*src)
{
// while (*src != '\0')
// {
// *dest++ = *src++;
//
// }
while (*dest++ = *src++)//判断条件里面先赋值后++
{
;//空语句返回继续循环
}
//斜杠0 字符ASCII是0 停下来了
}
这里一下子把\0和指针后移的操作和道理一起，看上去很妙，最后，遇到斜杠0 字符ASCII是0，while遇到0停下来了但是
有没有想过万一传进来的是空指针怎么办？程序什么也不会反应而且也没有return 0
7.5分答案
void my_strcpy(char*dest, char*src)
{
if (dest != NULL&&src != NULL)
{
while (*dest++ = *src++)
{
;
}
}
}
这时候我们做一个判断防止传入的是NULL，如果传入了NULL就不进入循环，这样还是arr1原样至少不会啥也没有
8分答案
void my_strcpy(char*dest, char*src)
{
assert(dest!=NULL);//若为假则会报错
assert(src!= NULL);
while (*dest++ = *src++)
{
;
}
}
assert防止传进来的是空指针，这个就比较好，因为NULL直接报错，这样直接就知道哪一行哪里出错了，其它人一看就知道是老司机，不是小白菜
但是还没有完，因为库里给到的函数是返回char*的而我们只是void*
9分答案
char* my_strcpy(char*dest,char*src)
{
assert(dest&&src);
char*ret=dest;
while (*dest++ = *src++）
{
;
}
return ret;
}
int main()
{
//strcpy
char arr1[] = "别复制到我这里";
char arr2[] = "别把我复制过去";
printf("%s\n",my_strcpy(arr1,arr2));
return 0;
}
现在离10分答案只差一步了
我们先了解一下const
const可以修饰变量和指针
修饰变量的时候变量变成了常变量，不能让你改变值，但是可以通过指针改变
const int n = 10;
int* p = &n;
那么怎么不让被指针修改呢?
const 放在*的左边
const修饰的指针指向的内容，表示指针指向的内容不能通过指针来改变
但是指针变量本身是可以改变的
const int* p = &n;
*p = 20;
//err
const 放在*的右边
const修饰的是指针变量本身，指针变量的内容不能被修改
但是指针指向的内容是可以通过指针来改变的
int* const p = &n;
p = &m;
//err
10分答案
char* my_strcpy(char*dest,const char*src)
{
assert(dest&&src);
char*ret=dest;
while (*dest++ = *src++)
{
;
}
return ret;
}
int main()
{
//strcpy
char arr1[] = "别复制到我这里";
char arr2[] = "别把我复制过去";
printf("%s\n",my_strcpy(arr1,arr2));
return 0;
}
const使得源头的数据不能被改变，这样的话源头更加安全，更加准确
拓展练习
实现strlen
#include <stdio.h>
int my_strlen(const char* str)
{
int count = 0;
assert(str != NULL);
while (*str)
{
count++;
str++;
}
return count;
}
int main()
{
const char* p = "abcdef";
int len = my_strlen(p);
printf("len = %d\n", len);
return 0;
}
小结:
简单的就strcpy函数的实现来展开关于写优秀代码的问题，当然要写出优秀的代码肯定不止这些，strcpy还是很简单的，未来会遇到更加复杂的代码，应该积累经验，多多练习
如果老铁们有收获的话，希望给个一键三连哦，谢谢