技术开发 频道

ERP设计之 C#书写规范

    【IT168 信息化

    一、命名  

    对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。  

    命名原则是: 

    选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。 

    以下几点是推荐的命名方法。 

    1、方法、属性、变量规范 

    ·    避免容易被主观解释的难懂的名称,如方面名 AnalyzeThis(),或者属性名 xxK8。这样的名称会导致多义性。  

    ·    在面向对象的语言中,在类属性的名称中包含类名是多余的,如 Book.BookTitle。而是应该使用 Book.Title。  

    ·    使用动词-名词的方法来命名对给定对象执行特定操作的例程,如 CalculateInvoiceTotal()。  

    ·    在允许函数重载的语言中,所有重载都应该执行相似的函数。 

    ·    只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。 

    ·    在变量名中使用互补对,如 min/max、begin/end 和 open/close。  

    ·    鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简化它们的阅读。另外,为了帮助区分变量和例程,请对例程名称使用 Pascal 大小写处理 (CalculateInvoiceTotal),其中每个单词的第一个字母都是大写的。对于变量名,请使用 CAMel 大小写处理 (documentFormatType),其中除了第一个单词外每个单词的第一个字母都是大写的。  

    ·    布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。  

    ·    在命名状态变量时,避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag,而是使用更具描述性的名称,如 documentFormatType。 (此项只供参考) 

    ·    即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。  

    ·    可能的情况下,尽量不要使用原义数字或原义字符串,如 For i = 1 To 7。而是使用命名常数,如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。 

 

0
相关文章