【转】编写高质量代码改进C#措施的157个建议

时间:2021-10-03 07:35:38

建议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同样糟糕,时间一长,即便开发者本人也会忘记当初所设定的这个变量的含义。