编写高质量代码改善C#程序的157个建议——建议142：总是提供有意义的命名

Posted 2020-10-17

 

建议142：总是提供有意义的命名

 除非有特殊原型，否则永远不要为自己的代码提供无意义的命名。

害怕需要过长的命名才能提供足够的意义？不要怕，其实我们更介意的是在代码的时候出现一个iTemp。

int i 这样的命名只能出现在循环中（如for循环），除此之外，我们找不到任何理由在代码的其他地方出现这样的无意义命名。

例如，以下命名都是良好的典范：

        private CultureInfo m_CurrentCulture;
        private CultureInfo m_CurrentUICulture;
        private int m_ManagedThreadId;
        private string m_Name;
        private int m_Priority;

        public static int GetDomainID()
        {
            return GetDomain().GetId();
        }

        public override int GetHashCode()
        {
            return this.m_ManagedThreadId;
        }

        private extern bool JoinInternal(int millisecondsTimeout);

 

 我们可以看到每一个命名都表达了本身具有的含义。良好的命名带来的一个显而易见好处是，我们甚至可以减少大部分的代码注释。

糟糕的命名如下：

        int theID;

        int GetID(int a, int b)
        {
            int iTemp;
            //省略
            return iTemp;
        }

 

这个反例，字段变量theID指示不明，阅读者看到这样的命名根本不知道开发者所表达的意思。方法GetID的参数a和b也是指示不明的，调用者根本不知道应该传入什么值。内部的ITemp同样糟糕，时间一长，即便开发者本人也会忘记当初所设定的这个变量的含义。

 

 

转自：《编写高质量代码改善C#程序的157个建议》陆敏技