代码规范:函数设计

简介: 除非告诉人们“危险”是什么,否则这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略,甚至被删除。 ↩︎

【规则 6-1-1】参数的书写要完整,不要贪图省事只写参数的类型而省略参数名字。


【规则 6-1-2】参数命名要恰当,顺序要合理。 参数的顺序要遵循程序员的习惯。一般地,应将目的参数放在后面,源参数放在前面。表示从哪里到哪里(取从左到右的含义)


【规则 6-1-3】如果参数是指针,且仅作输入用,则应在类型前加 const,以防止该指针在函数体内被意外修改


【规则 6-1-4】如果输入参数以值传递的方式传递对象,则宜改用“const &”方式来传递,这样可以省去临时对象的构造和析构过程,从而提高效率。


【建议 6-1-2】尽量不要使用类型和数目不确定的参数。

C 标准库函数 printf 是采用不确定参数的典型代表,其原型为:int printf(const chat *format[, argument]…);这种风格的函数在编译时丧失了严格的类型安全检查


6.2 返回值的规则

【规则 6-2-1】不要省略返回值的类型。


C 语言中,凡不加类型说明的函数,一律自动按整型处理。这样做不会有什么好处,却容易被误解为 void 类型。

C++语言有很严格的类型安全检查,不允许上述情况发生。由于 C++程序可以调用C 函数,为了避免混乱,规定任何 C++/ C 函数都必须有类型。如果函数没有返回值,那么应声明为 void 类型

【规则 6-2-3】不要将正常值和错误标志混在一起返回。正常值用输出参数获得,而错误标志用 return 语句返回。


6.3 函数内部实现的规则

不同功能的函数其内部实现各不相同,看起来似乎无法就“内部实现”达成一致的观点。但根据经验,我们可以在函数体的“入口处”和“出口处”从严把关,从而提高函数的质量。程序员守则:对他人保持悲观,对设计追求全面


【规则 6-3-1】在函数体的“入口处”,对参数的有效性进行检查。(我们不能保证调用者有完好的代码风格,只能保证我们自己的代码有足够的健壮性去容错)


return 语句不可返回指向“栈内存”的“指针”或者“引用”,因为该内存在函数体结束时被自动销毁。例如

char * Func(void)
{
  char str[] = “hello world”; // str 的内存位于栈上
  return str; // 将导致错误
}


要搞清楚返回的究竟是“值”、“指针”还是“引用”。

如果函数返回值是一个对象,要考虑 return 语句的效率。例如return String(s1 + s2);

6.4 其它建议

【建议 6-4-1】函数的功能要单一,不要设计多用途的函数。(但是可以将一个函数的功能拆的足够小,形成工具文件库)

【建议 6-4-2】函数体的规模要小,尽量控制在 50 行代码之内。

【建议 6-4-3】尽量避免函数带有“记忆”功能。相同的输入应当产生相同的输出。带有“记忆”功能的函数,其行为可能是不可预测的,因为它的行为可能取决于某种“记忆状态”。这样的函数既不易理解又不利于测试和维护。在 C/C++语言中,函数的 static 局部变量是函数的“记忆”存储器。建议尽量少用 static 局部变量,除非必需。

【建议 6-4-4】不仅要检查输入参数的有效性,还要检查通过其它途径进入函数体内的变量的有效性,例如全局变量、文件句柄等

【建议 6-4-5】用于出错处理的返回值一定要清楚,让使用者不容易忽视或误解错误情况。

6.5 使用断言

程序一般分为 Debug 版本和 Release 版本,Debug 版本用于内部调试,Release 版本发行给用户使用。


断言 assert 是仅在 Debug 版本起作用的宏,它用于检查“不应该”发生的情况。示例 6-5 是一个内存复制函数。在运行过程中,如果 assert 的参数为假,那么程序就会中止(一般地还会出现提示对话,说明在什么地方引发了 assert)。1

//复制不重叠的内存块
void *memcpy(void *pvTo, const void *pvFrom, size_t size)
{
  assert((pvTo != NULL) && (pvFrom != NULL)); // 使用断言
  byte *pbTo = (byte *) pvTo; // 防止改变 pvTo 的地址
  byte *pbFrom = (byte *) pvFrom; // 防止改变 pvFrom 的地址
  while(size -- > 0 )
  *pbTo ++ = *pbFrom ++ ;
  return pvTo;
}

【规则 6-5-1】使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别,后者是必然存在的并且是一定要作出处理的。

【规则 6-5-2】在函数的入口处,使用断言检查参数的有效性(合法性)

【建议 6-5-1】在编写函数时,要进行反复的考查,并且自问:“我打算做哪些假定?”一旦确定了的假定,就要使用断言对假定进行检查

【建议 6-5-2】一般教科书都鼓励程序员们进行防错设计,但要记住这种编程风格可能会隐瞒错误。当进行防错设计时,如果“不可能发生”的事情的确发生了,则要使用断言进行报警

6.6 引用与指针的比较

引用的一些规则如下:


(1)引用被创建的同时必须被初始化(指针则可以在任何时候被初始化)。


(2)不能有 NULL 引用,引用必须与合法的存储单元关联(指针则可以是 NULL)。


(3)一旦引用被初始化,就不能改变引用的关系(指针则可以随时改变所指的对象)。


对比上述三个示例程序,会发现“引用传递”的性质象“指针传递”,而书写方式


象“值传递”。实际上“引用”可以做的任何事情“指针”也都能够做,为什么还要“引用”这东西?


答案是“用适当的工具做恰如其分的工作”。


指针能够毫无约束地操作内存中的如何东西,尽管指针功能强大,但是非常危险。


就象一把刀,它可以用来砍树、裁纸、修指甲、理发等等,谁敢这样用?


如果的确只需要借用一下某个对象的“别名”,那么就用“引用”,而不要用“指针”,以免发生意外。


[服务器高级架构体系:https://xxetb.xet.tech/s/4DEnTI

assert 不是一个仓促拼凑起来的宏。为了不在程序的 Debug 版本和 Release 版本引起差别,assert 不应该产生任何副作用。所以 assert 不是函数,而是宏。程序员可以把assert 看成一个在任何系统状态下都可以安全使用的无害测试手段。如果程序在 assert处终止了,并不是说含有该 assert 的函数有错误,而是调用者出了差错,assert 可以帮助我们找到发生错误的原因。

很少有比跟踪到程序的断言,却不知道该断言的作用更让人沮丧的事了。

你化了很多时间,不是为了排除错误,而只是为了弄清楚这个错误到底是什么。

有的时候,程序员偶尔还会设计出有错误的断言。

所以如果搞不清楚断言检查的是什么,就很难判断错误是出现在程序中,还是出现在断言中。

幸运的是这个问题很好解决,只要加上清晰的注释即可。

这本是显而易见的事情,可是很少有程序员这样做。这好比一个人在森林里,看到树上钉着一块“危险”的大牌子。但危险到底是什么?树要倒?有废井?有野兽?

除非告诉人们“危险”是什么,否则这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略,甚至被删除。 ↩︎

目录
相关文章
|
8月前
|
监控 API 开发工具
HarmonyOS Next的HiLog日志系统完全指南:从入门到精通
本文深入解析HarmonyOS Next的HiLog日志系统,涵盖日志级别、核心API、隐私保护与高级回调功能,助你从入门到精通掌握这一重要开发工具。
|
数据采集 存储 数据处理
数据治理:如何制定数据标准与规范
在当今这个数据驱动的时代,数据已成为企业最宝贵的资产之一。然而,随着数据量的爆炸性增长和数据来源的多样化,如何有效地管理和利用这些数据成为了企业面临的重大挑战。数据治理作为确保数据质量、安全性、合规性和可访问性的关键过程,其核心在于制定并执行一套科学、合理的数据标准与规范。本文将探讨如何制定数据标准与规范,以推动企业的数据治理实践。
2258 3
|
前端开发 API UED
React 懒加载图片 Lazy Image
懒加载是一种优化技术,通过延迟加载不在视口内的图片,减少初始页面加载时间,提升用户体验。本文从基础概念入手,逐步探讨 React 中实现图片懒加载的常见问题、易错点及解决方案,并通过代码案例详细解释。
617 3
|
10月前
|
关系型数据库 MySQL PHP
利用PhpStorm、phpstudy和xdebug快速构建PHP调试环境
至此,我们已经完成了PHP调试环境的构建。现在,你可以在PhpStorm中打开你的PHP项目,设置断点,然后开始调试你的代码了。希望这个指南能帮助你快速构建PHP调试环境,提高你的开发效率。
629 26
|
9月前
|
缓存 安全 Java
【高薪程序员必看】万字长文拆解Java并发编程!(3-1):并发共享问题的解决与分析
活锁:多个线程相互影响对方退出同步代码块的条件而导致线程一直运行的情况。例如,线程1的退出条件是count=5,而线程2和线程3在其代码块中不断地是count进行自增自减的操作,导致线程1永远运行。内存一致性问题:由于JIT即时编译器对缓存的优化和指令重排等造成的内存可见性和有序性问题,可以通过synchronized,volatile,并发集合类等机制来解决。这里的线程安全是指,多个线程调用它们同一个实例的方法时,是线程安全的,但仅仅能保证当前调用的方法是线程安全的,不同方法之间是线程不安全的。
172 0
|
存储
Qt使用 QSetting 对 ini 配置文件进行操作
Qt使用 QSetting 对 ini 配置文件进行操作
1536 0
|
数据挖掘
【杂学笔记甲】问题分析和解决的流程及工具介绍
【10月更文挑战第2天】该文档详细介绍了问题解决的过程,包括定义问题、测量问题、分析问题、改善问题和控制问题五个阶段。在定义问题阶段,通过组建跨职能团队和运用4W1H方法明确问题;测量问题阶段则通过逻辑图和流程图等工具进行数据分析;分析问题阶段筛选关键原因并确认;改善问题阶段提出并筛选方案,进行试运行;最后控制问题阶段实施前后对比并总结经验,为后续挑战做准备。
647 11
【杂学笔记甲】问题分析和解决的流程及工具介绍
|
网络协议 Linux Windows
Rsyslog配置不同端口收集不同设备日志
Rsyslog配置不同端口收集不同设备日志
|
物联网 API 数据库
一文带你认识蓝牙 GATT 协议
正所谓磨刀不误砍柴工,我们有必要先深入的学习一下 GATT 以及 GATT 相关的一些知识。 本文我们就来了解一下 蓝牙 GATT 到底是什么?同时了解下我们使用的 ESP32-C3 GATT示例的工程的代码结构。
9097 5
一文带你认识蓝牙 GATT 协议
|
敏捷开发 开发者
Code Review 全面审查清单
Code Review 全面审查清单
1226 0
Code Review 全面审查清单

热门文章

最新文章