CODE COMPLETE 2e Chapter 11.1

本文详细阐述了在编程中变量命名的最佳实践,包括如何获取最佳名称、描述事物而非过程、保持命名长度适中、合理使用计算后缀、采用对仗词、避免通用名称等,并强调了命名规则对于代码清晰度和可维护性的重要性。

1、完全、准确的描述出该变量所代表的事物,最好的名字获取方式;

2、描述是什么,而不是如何? 选择 employData 而不是inputRec;

3、长度9-15 10-16个字符长度;

4、将计算限定值,如Total\ Min Max String Pointer Average Sum count Index等 放在名字的最后;

5、使用对仗词,next previous;

6、为循环下标命名,不要取ijk;

7、为状态变量命名,不要取名为flag,取名为 DataReady, 使用枚举类型;

8、为临时变量命名,临时的变量也不要随便用个temp,也有自己的现实意义;

9、为布尔变量命名,如 done, error, found, success, ok,不要取名为 IsDone,使用肯定的,而不是否定的,如NotFound;

10、为枚举类型命名,属于同一组,可以使用前缀;

11、为常量命名:表达其含义;

12、命名规则有诸多好处,有规矩,内部一致,利于传承,利于学习;


已经博主授权,源码转载自 https://pan.quark.cn/s/a4b39357ea24 QueueForMcu 基于单片机实现的队列功能模块,主要用于8位、16位、32位非运行RTOS的单片机应用,兼容大多数单片机平台。 开源代码:https://.com/xiaoxinpro/QueueForMcu 一、特性 动态创建队列对象 动态设置队列数据缓冲区 静态指定队列元素数据长度 采用值传递的方式保存队列数据 二、快速使用 三、配置说明 目前QueueForMcu只有一个静态配置项,具体如下: 在文件 中有一个宏定义 用于指定队列元素的数据长度,默认是 ,可以根据需要更改为其他数据类型。 四、数据结构 队列的数据结构为 用于保存队列的状态,源码如下: 其中 为配置项中自定义的数据类型。 五、创建队列 1、创建队列缓存 由于我们采用值传递的方式保存队列数据,因此我们在创建队列前要手动创建一个队列缓存区,用于存放队列数据。 以上代码即创建一个大小为 的队列缓存区。 2、创建队列结构 接下来使用 创建队列结构,用于保存队列的状态: 3、初始化队列 准备好队列缓存和队列结构后调用 函数来创建队列,该函数原型如下: 参数说明: 参考代码: 六、压入队列 1、单数据压入 将数据压入队列尾部使用 函数,该函数原型如下: 参数说明: 返回值说明: 该函数会返回一个 枚举数据类型,返回值会根据队列状态返回以下几个值: 参考代码: 2、多数据压入 若需要将多个数据(数组)压入队列可以使用 函数,原理上循环调用 函数来实现的,函数原型如下: 参数说明: 当数组长度大于队列剩余长度时,数组多余的数据将被忽略。 返回值说明: 该函数将返回实际被压入到队列中的数据长度。 当队列中的剩余长度富余...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值