如何更高效的写出更健全的代码,一篇文章教会你如何拥有一个良好的代码风格

简介: 如何更高效的写出更健全的代码,一篇文章教会你如何拥有一个良好的代码风格


    前言:在平常的写代码的过程中,或多或少的遇到很多奇怪的 bug ,尤其是一些大的程序,明明上一部分都是好好的,写下一块的时候突然多几百个 bug 的情况,然后这一块写完了后编译的时候直接傻眼了,看着满屏的 bug 根本不知道从哪开始改起,往往只能重新删掉,从头开始写。或者是明明代码写完了,编译器没有任何错误的提示,但是一旦跑起来程序就会立马崩溃。又或者明明代码没问题,跑起来也不报错,但是输出结果就是与期望相差甚远。

       其实以上种种情况的出现,往往都是写代码的习惯不好导致的,绝大多数情况下,拥有一个良好的代码风格可以帮助程序员省去很多的麻烦。


一.注意代码的可读性

       程序员写的代码不能只是这一个程序员看得懂,在职场中,往往是很多人去维护一个代码,所以,让别人看得懂你写的代码,是一件很关键的事情。

在写代码的时候,比如变量的申明和命名等,得做到合乎情理,举个例子,现在需要设计个通讯录管理系统,我们设计时需要慎重考虑如何对变量命名,就比如下面这俩段代码:

int main()
{
  char a[20] = { 0 };
  int b = 0;
  int c[11] = { 0 };
  char d = '0';
  return 0;
}
int main()
{
  char name[20] = { 0 };
  int age = 0;
  int number[11] = { 0 };
  char sex = '0';
  return 0;
}

   虽然这俩段代码设计的内容是一模一样的,变量的大小也是一模一样的,能完成的功能也是一模一样的,但是当你拿到俩个代码,哪个更容易看得懂直接就高下立判了


        所以在我们日常的写代码中,也要注意对于变量的命名等也要稍作思考再进行命名,不仅是为了方便他人,更是为了方便我们自己,如果是不加思考的命名,可能代码写到后部分都已经忘了前部分是干嘛的了


       此外也得多使用注释,对于逻辑的表述要清晰,哪一块代码是干什么用的,哪个变量的命名是为了别的变量服务的,都要使用注释进行申明,这样也可以帮助自己整理思绪,写出更高质量的代码


二.合理的使用 const

       const 在c语言中是关键字,是 constant 的简写,用来定义常量,它限定一个变量不允许被改变,产生静态作用。被 const 修饰的变量,我们称之为常变量。

       这可以更高效合理的帮助我们管理代码,比如在函数传参的时候,我并不希望我传入的参数被改变,我只是想用这个参数算出一个结果,但是并不改变这个参数本身的地址或者数值大小,这个时候我们就可以使用 const 关键字。

对于普通变量的使用

int main()
{
  int num = 0;
  num = 10;
  printf("%d\n", num);
  num = 200;
  printf("%d\n", num);
  system("pause");
  return 0;
}

我们可以观察到,在使用 const 之前,变量 num 是可以更改的

int main()
{
  int const num = 0;
  num = 10;
  printf("%d\n", num);
  num = 200;
  printf("%d\n", num);
  system("pause");
  return 0;
}

但是在添加了 const 之后就不能改被 const 修饰的 num 的值了

对于指针的使用

const 放在 * 左边

       限制的指针指向的内容,也就是说:不能通过指针来修改指针指向的内容

       但是指针变量是可以修改的,也就是指针指向其他变量的

int main()
{
  const int num = 10;
  const int * p = (int*) & num;
  int n = 1000;
  *p = 20;//err
  p = &n;
  return 0;
}

在这里就会报错提示

const 放在 * 右边


限制的是指针变量本身,指针变量不能再指向其他对象

      但是可以通过指针变量来修改指向的内容

int main()
{
  const int num = 10;
  int * const  p = (int*) & num;
  int n = 1000;
  *p = 20;
  p = &n;//err
  return 0;
}

在这里就会报错提示


三.合理的使用 assert

assert 宏的原型定义在 <assert.h> 中,其作用是先计算表达式的值为假 (即为 0 ),那么它就先向 stderr 打印一条出错信息,然后通过条用 abort 来终止程序;


       比如我们可以写个死循环,正常情况下,死循环的程序会一直跑下去,但是我们使用了 assert 语句后,就会有这样的情况:

int main()
{
  int i = 1;
  while (i)
  {
    i++;
    assert(i != 10);
  }
  return 0;
}

       这里的 while 循环是死循环,每一次i的值加一,从 1 开始加永远不会为 0while 循环会一直循环下去,可是,我们这里的断言语句每一次都会进行判断,判断当前值是否不等于 10,如果判断条件为假,则进行报错警告,并且终止程序

assert(i != 10);

四.综合示例

1.模拟实现 strlen 函数

       既然是函数,那我们对于参数的设计就需要稍微思考了,求字符串的长度的前提就是,我们得拿到这个字符串的地址,拿地址就需要使用指针,并且我们要的只是拿到地址而已,并不需要对这个地址进行什么更改操作,所以我们这里可以使用 const 进行修饰,并且为了与需求匹配,const 应该放在 * 的左边。


       同时,对于我们传入的地址,我们应该对其进行判断,要求字符串的长度,那首地址总不可能为空吧,所以在这里使用 asset 进行断言,如果传入的地址参数为空就进行报错。


//模拟实现一个strlen函数
size_t my_strlen(const char* str)
{
  //assert(str != NULL);
  assert(str);
  size_t count = 0;
  while (*str)
  {
    count++;
    str++;
  }
  return count;
}
int main()
{
  char arr[] = "abcdef";
  size_t len = my_strlen(arr);
  printf("%zd\n", len);
  system("pause");
  return 0;
}

运行结果示例:

2.模拟实现 strcpy 函数

 需要将一个字符串拷贝进入另一个字符串,那就需要知道这俩个字符串的地址,在知道地址后我们为了不修改原地址,使用 const 进行维护,同时使用 assert 判断传入的地址参数是否为空,如果为空就报错

char* my_strcpy(char* dest, const char* src)
{
  //断言
  char* ret = dest;
  assert(dest != NULL);
  assert(src != NULL);
  //从src指向的字符串中拷贝内容到dest指向的空间
  //\0也会被拷贝到目标空间
  while (*dest++ = *src++)
  {
    ;
  }
  return ret;
}
int main()
{
  char arr1[20] = "xxxxxxxxxxxxxx";
  char arr2[] =   "hello everyone";
  printf("%s\n", my_strcpy(arr1, arr2));
  system("pause");
  return 0;
}

运行结果示例:

         

       以上就是本次分享的全部内容了,希望对屏幕前的您有所帮助,如有内容上的错误,欢迎指出,也欢迎积极讨论,内容制作不易,给个三连支持一下吧

目录
相关文章
|
人工智能 自然语言处理 安全
如何提升代码质量,重构并非“万能药”
随着编程技术的不断进步,编程语言变得越来越高级,功能封装也越来越完善。各种技术都在帮助程序员提高编写代码的效率。通过层层封装,程序员似乎不需要了解技术细节,只需逐行翻译需求内容即可。 许多程序员不了解如何组织代码、提升运行效率以及底层基于的原理是什么,但是他们编写的代码通过了编译、测试,并且在上线运行了一个月而没有出现问题,似乎并没有对他们的实际工作产生明显的负面影响。
|
1月前
|
前端开发 JavaScript 测试技术
前端测试技术中,如何提高集成测试的效率?
前端测试技术中,如何提高集成测试的效率?
|
5月前
|
设计模式 数据处理 开发者
LabVIEW软件开发中的代码重构如何帮助维护代码质量?
LabVIEW软件开发中的代码重构如何帮助维护代码质量?
55 0
|
7月前
|
C++
C++代码的可读性与可维护性:技术探讨与实践
C++代码的可读性与可维护性:技术探讨与实践
122 1
|
7月前
|
测试技术
【测试】构建质量保证之路:编写测试用例的艺术
【测试】构建质量保证之路:编写测试用例的艺术
|
4月前
|
敏捷开发 jenkins 测试技术
自动化测试之美:打造高效软件测试流程
【8月更文挑战第31天】在软件开发的海洋中,自动化测试犹如一艘航船,引导着项目向着质量的灯塔航行。本文将揭开自动化测试的神秘面纱,从基础理论到实践操作,一步步构建起你的测试框架。你将学会如何编写实用的测试脚本,并将其融入日常开发,最终让测试成为敏捷开发不可或缺的力量。让我们启航,探索自动化测试的世界,确保代码之船稳健前行。
|
3月前
|
测试技术 数据安全/隐私保护
软件测试的艺术:如何高效地编写测试用例
【9月更文挑战第2天】在软件开发的海洋中,测试用例是导航灯塔,指引着质量保障的航向。本文将带你航行于测试用例编写的技巧之海,从理解需求到设计思路,再到实际执行,我们将一起探索如何高效而精准地构建测试用例,确保软件的稳健与可靠。
78 0
|
7月前
|
Java 测试技术 开发者
深入理解与应用单元测试:软件质量的守护者
【4月更文挑战第30天】 在现代软件开发过程中,单元测试作为保障代码健康的重要环节,其地位日益凸显。本文将探讨单元测试的核心概念、实施单元测试的重要性以及如何高效地设计并执行单元测试。通过实例分析,我们将揭示单元测试在确保软件产品质量和加速开发周期中的关键作用。
|
7月前
|
设计模式 并行计算 算法
代码之韵:高效编程的艺术深入理解软件自动化测试框架的设计与实现
【5月更文挑战第29天】在数字世界的构建中,编程不仅仅是一门科学,更是一种艺术。本文将探讨如何通过理解编程的本质、掌握设计模式、运用算法智慧以及持续的性能优化过程,来提升编程效率和代码质量。我们将从宏观的架构设计到微观的代码细节,剖析那些让代码更加优雅、高效且易于维护的技巧与实践。
|
7月前
|
安全 NoSQL 程序员
【年度征文 健壮代码 心得体会】 如何编写健壮的C++代码
【年度征文 健壮代码 心得体会】 如何编写健壮的C++代码
116 0
下一篇
DataWorks