关于C#代码的局部变量命名

以前Kingdee的下一代产品是基于.NET平台使用C#,我当时参考了一些文档,编写了Kingdee公司中的《C#编码规范》。整个规范比较冗长,我也不打算详细说明。现在我和大家讨论一下关于局部变量的命名。

变量命名必须直观易懂,尽量不使用缩写,必要时与类型相关。在阅读别人代码时,如发现一个好的变量命名,你应该记下来,这是一个很好的经验积累。尽量不要使用缩写,使用缩写时,最好使用通用的缩写。

以下是一个示例,欢迎大家讨论。同时也把自己的一些好的命名共享出来!

//Array后缀的数组变量
Object[] objArray = ...;

//使用类型的缩写
DataTable dataTable = ...;

//变量的声明,类型尽量使用接口,这样对于修改实现容易
IList list = new ArrayList();

//flag是一个常用的变量
bool flag = false;

//item也是一个常用的命名
foreach (Object item in list) 
{
    
if (flag) 
    
{
        Console.Write(
",");
    }


    flag 
= true;  //flag之前有一个空行,代码中应有恰当的分行
}


//使用符合短语对变量命名
String typeName = obj.GetType().GetName();

//优化for循环时的临时变量名
int listCount = list.Count;
for (int i = 0; i < listCount; ++i) {}

我会陆续写一些关于代码风格的文章,也欢迎大家与我讨论。

posted on 2004-07-22 00:26 温少 阅读(...) 评论(...) 编辑 收藏

导航