【C语言】深度讨论使代码更严谨,更优雅的方式

🚩纸上得来终觉浅, 绝知此事要躬行。
🌟主页:June-Frost
🚀专栏:C语言

🔥该篇将从多个部分探讨如何写出更严谨,更优雅的代码。
🌏该文章借鉴《高质量 C++/C 编程指南》—— 林锐。

目录:

  • 🌟命名
  • 🌟 空行
  • 🌟 语句
    • ✉️ 表达式语句
    • ✉️ 函数调用语句
    • ✉️ 控制语句
      • 📬一些共性
      • 🔭分支语句
      • 🔭循环语句
  • 🌟指针
  • 🌟 函数
  • ❤️ 结语

🌟命名

 📗在编程中,命名是非常重要的,一个好的命名可以帮助别人更好地理解代码,提升代码的可读性和可维护性,常见的命名规则有: ①驼峰命名法(又叫小驼峰法,单词的第一个字母小写,后面的单词的首字母大写,例如:int myAge = 0),②下划线命名法(所有字母小写,单词之间用下划线连接,例如:int first_name = 0),③帕斯卡命名法(又叫大驼峰法,将第一个单词的首字母和其他单词的首字母均大写,例如:int FirstName = 0),④匈牙利命名法(将变量名的前缀指定为变量的数据类型,例如:int iname = 0//这里的i代表int)。
 但是,随着不同的语言以及不同IDE的发展,其所推崇的规则是不同的,况且命名对程序的影响无足轻重,不同的项目和团队可能也有着自己的命名风格。所以我们应该关注命名的共性规则。

  • 标识符应该可以清晰表达含义,最好使用英文单词组合,切记不可以使用拼音
  • 标识符最好能以最短的长度描述出最多的信息,避免使用缩写,除非是广泛使用的行业标准缩写,例如SL //水利行业标准 ,此外单个字母也并非无用,有时可以用于循环变量。
  • 避免通过大小写来区分。例如:int o; int O;,这种写法极容易混淆。
  • 变量名称使用 形容词+名词或者 名词,例如: int flag;int newFlag;
  • 函数名称使用 动词+名词或者动词 ,例如:Init();InitBoard();
  • 避免使用编号(除非逻辑必要)和特殊字符,例如int num1; int num2;

Windows环境下的一些建议:

  • 常量名和宏定义使用大写字母和下划线,例如MAX_LENGTH
  • static 修饰的静态变量加前缀 s_ , 例如:static int s_newFlag = 0
  • 若要使用全局变量,变量需要加前缀 g_ (表示 global) ,例如: int g_flag;//全局变量

🌟 空行

📗适当的空行可以帮助分隔不同的代码块从而提高可读性,并且阅读者可以很容易地区分不同的代码段,更轻松地理解代码逻辑。在总体的布局上也会显得更加美观。

  •  在函数声明或者定义之间增加空行,以区分不同的函数,这样可以快速的找到特定的代码块。
//空行
int calculateAverage(...)
{//业务处理
}
//空行
void GetCustomerDetails(...)
{//业务处理
}
  •  逻辑密切相关的地方不加空行,其它地方加空行,以分隔不同的逻辑部分,有利于阅读者更好地理解代码的结构和逻辑关系。

  •  在代码的不同部分之间增加空行,例如,在循环语句,条件语句,变量声明之间添加以助于分隔不同的代码块。

//空行
while (...)
{description1;//空行if (...){//业务处理}else{//业务处理}//空行description2;
}

但是需要注意,空行固然有着诸多好处,但是过度添加空行可能会使得代码过于稀疏,反而影响了可读性,所以一定要确保在合适的位置增加。


🌟 语句

✉️ 表达式语句

 优雅的表达式应该是简洁、易读、清晰和易于理解的。应该使用适当的命名、合适的语法和惯用的风格来书写表达式,以便使代码更易于维护和扩展。以下是一些建议:

  • 避免冗长和复杂的表达式,尽量不书写多用途的表达式,例如:可以将d = (a = b + c) + r ; 改为 a = b + c; d = a + r;;
  • 在适当的情况下使用括号可以明确表达式的优先级和分组,避免混淆和误解。例如:求一个闰年,return ((year%4 == 0)&&(year%100!=0))||(year%400 == 0);
  • 避免使用全局变量。全局变量可以使代码难以理解和维护,因为它们的作用域不明确,并且可能会被意外地修改。尽可能使用局部变量或参数,这可以使代码更安全和可预测。
  • 表达式的一些双目操作符,例如赋值操作符、比较操作符、算术操作符等,前后应该加空格。一些单目操作符,例如逻辑反操作( !),按位取反(~)等,前后不加空格。还有一些操作符,例如下标引用( [ ] )、结构成员( -> 和 . ) 前后不加空格 。

✉️ 函数调用语句

  • 函数名之后不要留空格,紧跟左括号‘(’ 。
  • ‘,’之后要留空格

✉️ 控制语句

📬一些共性

  • 关键字之后要留空格。像const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。
  • 对于表达式比较长的 for 语句和 if 语句,为了紧凑起见可以适当地去掉一些空格,如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))
  • 如果一行的字符过多,则需要长句拆分,长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首,如果可能,使表达式的每一行都不超过限制字符数(通常是80个字符)。
    例如:
              if((*p==')'&&STTop(&s1)!='(')||(*p==']'&&STTop(&s1)!='[')||(*p=='}'&&STTop(&s1)!='{'))
  • if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。并且程序的分界符‘{’和‘}’应独占一行并且位于同一列(如果出现嵌套的{},则使用缩进对齐) ,这些做法也可以防止产生悬空else,

悬空else:

#include<stdio.h>
int main()
{int a = 0;int b = 2;if (a == 1)if (b == 2)printf("点赞\n");elseprintf("收藏\n");return 0;
}

注意:else 会和 最近的if 匹配 。 最好加入{} ,这样可以使得代码中的匹配更加明确。

🔭分支语句

  • if 语句的条件判断中,如果是与0比较,最好能让读者一眼看出类型,例如,布尔类型:BOOL value=0;......;if(value)//表示为真时执行 ,整型类型:int value = 0;........;if(value!=0), 指针类型:int* value = NULL;........;if(value !=NULL)
  • 在switch语句中,即使程序真的不需要 default 处理,也应该保留语句 default 。甚至可以加个break 。

🔭循环语句

  • 如果循环体内存在逻辑判断,并且循环次数很大,宜将逻辑判断移到循环体的外面。

例如:
如果N(循环次数)大,可以采用该方式,不会打断“流水线”作业,能提高效率。

if (condition) 
{ for (i=0; i<N; i++) {//业务处理}
} 
else 
{ for (i=0; i<N; i++) {//业务处理}
} 

如果N比较小,两者差别不明显。以下这种更加简洁。

for (i = 0; i < N; i++)
{if (condition){//业务处理}else{//业务处理}
}
  • 不可在 for 循环体内修改循环变量,防止 for 循环失去控制。循环变量的调整只放在表达式3中可以防止出现问题。
  • 建议 for 语句的循环控制变量的取值采用“半开半闭区间”写法。虽然for (i=0; i<=9; i++)和for (i=0; i<10; i++)都是循环10次,但是第二个更加直观。

🌟指针

 想要将代码写的更严谨,那么必须杜绝野指针(指针指向的位置是不可知的(随机的、不正确的、没有明确限制的)),野指针可能会导致数据错误,程序崩溃等一系列问题。
野指针是如何形成的呢?
1.指针未初始化

#include <stdio.h>
int main()
{int *p;//局部变量指针未初始化,默认为随机值*p = 20;return 0;
}

2.指针越界访问

#include <stdio.h>
int main()
{int arr[10] = {0};int *p = arr;int i = 0;for(i=0; i<=11; i++){//当指针指向的范围超出数组arr的范围时,p就是野指针*(p++) = i;}return 0;
}

3.指针指向的空间释放:指针被 free 或者 delete 之后,没有置为 NULL,让人误以为是个合法的指针。

解决方案:

  1. 指针初始化
  2. 小心指针越界
  3. 指针指向空间释放,及时置NULL
  4. 避免返回局部变量的地址
  5. 指针使用之前检查有效性
#include <stdio.h>
int main()
{int *p = NULL;//....int a = 10;p = &a;if(p != NULL){*p = 20;}return 0;
}

🌟 函数

  • 参数命名要恰当,顺序要合理。例如要实现strcpy,我们就可以将源字符串起名为strSource ,目的字符串为strDestination ,这样写代码就会很清楚从哪里拷贝到哪里,而且,一般地,应将目的参数放在前面,源参数放在后面。这样就得到了函数声明 :char * StringCopy(char* strDestination, const char* strSource );
  • 如果输入参数以值传递的方式传递对象,则宜改用“const &”方式来传递,这样可以省去临时对象的构造和析构过程,从而提高效率。

例如:

#include<stdio.h>
struct S
{int data[1000];int num;
};
struct S s = { {1,2,3,4}, 1000 };
//结构体传参
void print1(struct S s)
{printf("%d\n", s.num);
}
//结构体地址传参
void print2(const struct S* ps)
{printf("%d\n", ps->num);
}
int main()
{print1(s); //传结构体print2(&s); //传地址return 0;
}

 如果传递一个结构体对象的时候,结构体过大,参数压栈的系统开销比较大,所以会导致性能的下降,传递指针则不会。

  • 函数名字与返回值类型在语义上不可冲突。

 这一点很重要,例如可能人们会误以为 getchar 的返回类型是char,其实不然。这个函数的机制是:如果正确读取到一个字符,则返回ASCll码值,如果读取不正常,则会返回EOF(end of file,文件结束标志),EOF其实就是 -1 。🌈对于char类型,一些编译器定义的范围为 -128 ~ 127,还有一些为 0~255 。如果是后者,在返回 -1 时就会出错,另外,对于ASCll码表的扩展字符,就算时 -128 ~ 127 也无法表示,所以采取大范围的 int 更加合适。
  所以当我们自己设计函数时,要尽量避免出现误导的情况。

  • 在进入函数体后,使用assert(断言)对参数的有效性进行检查。如果传入的参数是非法的,那么assert就会报出错误,对检查bug有一定的帮助。
  • 如果参数是指针,且仅作输入用,则应在类型前加 const,以防止该指针在函数体内被意外修改。

针对这两点,就可以模拟实现一个大致合格的 strcpy 函数。

char* StringCopy(char* strDestination, const char * strSource)
{char* ret = strDestination;//断言assert(strDestination != NULL);assert(strSource != NULL);while (*strDestination++ = *strSource++){;//空语句}return ret;
}

❤️ 结语

 文章到这里就结束了,如果对你有帮助,你的点赞将会是我的最大动力,如果大家有什么问题或者不同的见解,欢迎大家的留言~

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/96975.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

北京APP外包开发需要注意的问题

开发APP的过程中&#xff0c;由于开发APP需要投入大量的时间、精力和资源&#xff0c;所以在开始前一定要做好充足的准备和规划。您需要注意以下重点&#xff0c;希望对大家有所帮助。北京木奇移动技术有限公司&#xff0c;专业的软件外包开发公司&#xff0c;欢迎交流合作。 1…

深入剖析 Golang 程序启动原理 - 从 ELF 入口点到GMP初始化到执行 main!

大家好&#xff0c;我是飞哥&#xff01; 在过去的开发工作中&#xff0c;大家都是通过创建进程或者线程来工作的。Linux进程是如何创建出来的&#xff1f; 、聊聊Linux中线程和进程的联系与区别&#xff01; 和你的新进程是如何被内核调度执行到的&#xff1f; 这几篇文章就是…

ChatGPT Prompting开发实战(四)

一、chaining prompts应用解析及输出文本的设定 由于输入和输出都是字符串形式的自然语言&#xff0c;为了方便输入和输出信息与系统设定使用的JSON格式之间进行转换&#xff0c;接下来定义从输入字符串转为JSON list的方法&#xff1a; 定义从JSON list转为输出字符串的方法&…

[杂谈]-2023年实现M2M的技术有哪些?

2023年实现M2M的技术有哪些&#xff1f; 文章目录 2023年实现M2M的技术有哪些&#xff1f;1、寻找连接2、M2M与IoT3、流行的 M2M 协议 在当今的数字世界中&#xff0c;机器对机器 (M2M) 正在迅速成为标准。 M2M 包括使联网设备能够交换数据或信息的任何技术。 它可以是有线或无…

MongoDB 会丢数据吗? 在次补刀MongoDB 双机热备

开头还是介绍一下群&#xff0c;如果感兴趣PolarDB ,MongoDB ,MySQL ,PostgreSQL ,Redis &#xff0c;Oracle ,Oceanbase 等有问题&#xff0c;有需求都可以加群群内有各大数据库行业大咖&#xff0c;CTO&#xff0c;可以解决你的问题。加群请加微信号 liuaustin3 &#xff08;…

2023开学礼山东财经大学《乡村振兴战略下传统村落文化旅游设计》许少辉新财经图书馆

2023开学礼山东财经大学《乡村振兴战略下传统村落文化旅游设计》许少辉新财经图书馆

一、C#—概述环境安装(1)

&#x1f33b;&#x1f33b; 目录 一、 C#概述1.1 为啥学习C#1.2 TIBOE编程语言排行榜1.3 IEEE编程语言排行榜1.4 什么是C#1.5 C#创始人1.6 C#发展历史1.7 C#特点1.8 C#与Java1.9 .NET Framework1.10 C# 与 .NET Framework1.11 C#得应用领域1.12 C#能做什么 二、开发环境得安装…

C++算法 —— 动态规划(1)斐波那契数列模型

文章目录 1、动规思路简介2、第N个泰波那契数列3、三步问题4、使用最小花费爬楼梯5、解码方法6、动规分析总结 1、动规思路简介 动规的思路有五个步骤&#xff0c;且最好画图来理解细节&#xff0c;不要怕麻烦。当你开始画图&#xff0c;仔细阅读题时&#xff0c;学习中的沉浸…

电源模块的降额曲线

大家好&#xff0c;这里是大话硬件。 今天想写这篇文章来分享在前段时间了解的一个知识点——电源模块的降额曲线。 为什么要写这个呢&#xff1f;对于专门做电源的同学来说&#xff0c;肯定觉得很简单。但是对于一个非电源行业的人来说&#xff0c;曲线应该如何解读&#xff…

智能安全科技,Vatee万腾为您服务

在智能科技的引领下&#xff0c;Vatee万腾将为您点亮投资之路&#xff0c;助您在金融市场中抓住机遇&#xff0c;实现财务目标。作为一家融合科技与投资的先锋平台&#xff0c;Vatee万腾致力于为投资者提供智能化的投资方案和支持。 Vatee万腾以其先进的智能科技为基础&#xf…

技术科普:汽车开放系统架构AUTOSAR

01.AUTOSAR简介 汽车是现代人类实现“千里江陵一日还”的交通工具&#xff0c;而计算机则是使人脱离繁杂重复脑力劳动的生产技术&#xff0c;两者的结合催生了汽车电子产业的蓬勃发展。 21世纪初&#xff0c;随着汽车电子应用需求的不断增多与硬件资源不断丰富&#xff0c;软…

监控平台 - zabbix

目录 一、概述 二、搭建 一、概述 1. zabbix程序结构 zabbix-server&#xff1a;用于数据处理及写入到数据库 zabbix-agent&#xff1a;用于获取被监控端的性能检测数据 zabbix-web&#xff1a;用于数据的展示及远程操控 数据库&#xff1a;用于存储监控数据 zabbix-pr…