《编写可读代码的艺术》---变量和可读性

对变量的草率使用,会导致程序的难以理解,原因是以下几点

  • 变量越多,就越难以全部跟踪他们的动向
  • 变量的作用域越大,就需要跟踪它的动向越久
  • 变量改变的越频繁,就越难以跟踪它的当前值。

下面来讨论如何改善这些问题。

1 减少变量

 仅当我们需要的时候,才使用变量,下面将列举出一些没必要存在的变量的。

   1.1 没有价值的临时变量

一般有经验的程序员是不会刻意写个没有价值的临时变量。造成临时变量没有使用价值的原因,可能是多次修修改改之后遗留的结果。

 来个日期赋值的例子

            DateTime now = DateTime.Now;
            File.SetLastWriteTime("c://1.txt",now);

名叫“now”的变量没有存在价值,因为

  • 它没有拆分任何复杂的表达式
  • 它传递的信息有限:表达式DateTime.Now已经解释的很清楚了
  • 生命之后,它只用了一次,没有压缩任何冗余的代码

去掉变量now,代码任然易于理解

  File.SetLastWriteTime("c://1.txt",DateTime.Now);

 

1.2减少中间结果

来个从数组中剔除元素的例子

复制代码
       /// <summary>
        /// 从数组中剔除指定的元素
        /// </summary>
        public static void kickItemFromArray<T>(List<T> array, T objToKick)
        {
            int numToKickIndex = -1;

            for (int i = 0; i < array.Count; i++)
            {
                if (array[i].Equals( objToKick))
                {
                    numToKickIndex = i;
                    break;
                }
            }

            if (numToKickIndex>=0)
            {
                Console.WriteLine("kick:"+numToKickIndex);
                array.RemoveAt(numToKickIndex);
            }
        }
复制代码

变量numToKickIndex只是用来存储临时结果,我们可以通过立刻处理临时的结果,来减少中间变量的数量

复制代码
        /// <summary>
        /// 从数组中剔除指定的元素
        /// </summary>
        public static void kickItemFromArray<T>(List<T> array, T objToKick)
        {
            for (int i = 0; i < array.Count; i++)
            {
                if (array[i].Equals( objToKick))
                {
                    //立刻剔除该元素,并返回
                    array.RemoveAt(i);
                    break;
                }
            }
        }
复制代码

1.3 减少控制流变量

在while、for等循坏语句中,我们通常使用自定义的bool变量,来控制流转

复制代码
            bool isDone = false;

            while (/*自定义条件*/&&isDone ==false)
            {
                if (/*满足isDone条件*/)
                {
                    isDone = true;
                    continue;
                }
            }
复制代码

像isDone这样的变量,成为“控制流程变量”,它没有包含任何程序的数据,唯一的目的是控制程序的流转。

在我们的经验中,“控制流程变量”可以通过优化程序的结构、逻辑来消除。

            while (/*自定义条件*/)
            {
                if (/*满足isDone条件*/)
                {
                    break;
                }
            }

这个例子比较简单,如果嵌套层级、个数比较多等复杂情况,我们可以通过把循环中的代码、整个循环提取到一个新的函数中来改善情况。

2 缩小变量的作用域

我们都听过“避免全局变量”的建议。这是一条很好的建议,因为很难跟踪这些全局变量在哪里以及如何使用它们。

并且因为“命名空间污染”(全局变量与局部变量命名相同),代码可能意外地改变全局变量的值。

实际上,让所有变量都“缩小作用域”是一个好主意,并非只针对全局变量。

关键思想

让你的变量对尽量少的代码可见

很多语言里面提供了访问级别的控制,涵盖了模块、类、函数和语句块的作用域。

通常越严格的访问控制越好,因为这意味着该变量对更少的代码行“可见”。这样有效地减少了读者同时需要考虑的变量个数---如果你能把所有的变量作用域都减半,那么这意味着需要同时思考的变量个数,平均是原来的一半。

 

 

 

 

posted @   谪仙  阅读(568)  评论(0编辑  收藏  举报
编辑推荐:
· go语言实现终端里的倒计时
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
阅读排行:
· 周边上新:园子的第一款马克杯温暖上架
· 分享 3 个 .NET 开源的文件压缩处理库,助力快速实现文件压缩解压功能!
· Ollama——大语言模型本地部署的极速利器
· DeepSeek如何颠覆传统软件测试?测试工程师会被淘汰吗?
· 使用C#创建一个MCP客户端
点击右上角即可分享
微信分享提示