命名
對於理解應用程序的邏輯流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
命名原則是:选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。
以下幾點是推薦的命名方法。
例程
避免容易被主觀解釋的難懂的名稱,如对于例程的 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 以便于维护和理解。
表
在命名錶時,用单数形式表示名称。例如,使用 Employee,而不是 Employees。
在命名錶的列時,不要重复表的名称;例如,在名为 Employee 的表中避免使用名为 EmployeeLastName 的字段。
不要在列的名稱中包含數據類型。如果后来有必要更改数据类型,这将减少工作量。
Microsoft SQL Server
不要給存儲過程加 sp 前缀,这个前缀是为标识系统存储过程保留的。
不要給用戶定義的函數加 fn_ 前缀,这个前缀是为标识内置函数保留的。
不要給擴展存儲過程加 xp_ 前缀,这个前缀是为标识系统扩展存储过程保留的。
雜項
儘量減少使用縮寫,而是使用以一致方式创建的缩写。缩写应该只有一个意思;同样,每个缩写词也应该只有一个缩写。例如,如果用 min 作为 minimum 的缩写,那么在所有地方都应这样做;不要将 min 又用作 minute 的缩写。
在命名函數時包括返回值的說明,如 GetCurrentWindowName()。
與過程名一樣,文件和文件夹的名称也应该精确地说明它们的用途。
避免對不同的元素重用名稱,如名为 ProcessSales() 的例程和名为 iProcessSales 的变量。
在命名元素時避免同音異義詞(如 write 和 right),以防在检查代码时发生混淆。
在命名元素時,避免使用普遍拼错的词。另外,应清楚区域拼写之间存在的差异,如 color/colour 和 check/cheque。
避免用印刷標記來標識數據類型,如用 $ 代表字符串或用 % 代表整数。