¶Code Complete II《軟體建構之道 2》#11 讀書心得與整理

原文連結: https://darkblack01.blogspot.com/2013/04/code-complete-ii-211.html
移植時的最後更新日期: 2013-04-24T23:48:51.929+08:00

第十一章 變數名稱的力量
The Power of Variable Names

11.1 選擇良好名稱的注意事項Considerations in Choosing Good Names

//Java Example of Poor Variable Names
x = x - xx;
xxx = aretha + SalesTax( aretha );
x = x + LateFee( x1, x ) + xxx;
x = x + Interest( x1, x );

//Java Example of Good Variable Names
balance = balance - lastPayment;
monthlyTotal = NewPurchases + SalesTax( newPurchases );
balance = balance + LateFee( customerID, balance ) + monthlyTotal;
balance = balance + Interest( customerID, balance );

最重要的命名注意事項
The Most Important Naming Consideration

• 容易閱讀
• 無難猜的縮寫
• 無歧義
• 不會搞混
• 好記

問題導向
Problem-Orientation

最佳命名長度
Optimum Name Length

Scop對變數名稱的影響
The Effect of Scope on Variable Names

1. 對於有支援namespace的語言: 使用namespace管理
2. 不支援namespace的語言: 命名時加上修飾詞

變數名稱中的計數專用修飾詞
Computed-Value Qualifiers in Variable Names

1. 避免佔用變數命名的前面，變數命名的前面提供變數意義(理解變數的目的)
2. 避免出現totalRevenue和revenueTotal的混淆(語意相同，當作不同)。
3. 有優雅對稱性的命名規則
4. 改善可讀性、維護更容易

常見的成對的變數名稱
Common Opposites in Variable Names

11.2 為特定資料種類命名
Naming Specific Types of Data

命名迴圈的索引變數
Naming Loop Indexes

• 最常見的名字是i, j, k 
在小迴圈內用的變數:

//Java Example of a Simple Loop Variable Name
for ( i = firstItem; i < lastItem; i++ )
    data[ i ] = 0;

• 避免使用i, j, k，而使用更有意義的名稱
1. 迴圈外也要用的變數:

//Java Example of a Good Descriptive Loop Variable Name
recordCount = 0;
while ( moreScores() )
{
    score[ recordCount ] = GetNextScore();
    recordCount++;
}
something = recordCount;
//...

2. 在長迴圈內/巢狀迴圈用的變數:

//Java Example of Good Loop Names in a Nested Loop
for ( teamIndex = 0; teamIndex < teamCount; teamIndex++ ) {
for ( eventIndex = 0; eventIndex < eventCount[ teamIndex ]; eventIndex++ ) {
    score[ teamIndex ][ eventIndex ] = 0;
}}

命名狀態變數
Naming Status Variables

if ( printFlag == 16 )
statusFlag = 0x80;

enum ReportType {
    ReportType_Daily,
    ReportType_Monthly,
    ReportType_Quarterly,
    ReportType_Annual,
    ReportType_All
};
if ( reportType == ReportType_Annual )
    //...
const int CONTROL_CHARACTER = 0x80;
characterType = CONTROL_CHARACTER;

命名臨時變數
Naming Temporary Variables

1. 存放計算的中繼結果(hold intermediate results of calculations)
2. 作為暫時符號(temporary placeholders)
3. 存放內部整理的值(to hold housekeeping values)

//C++ Example of an Uninformative “Temporary” Variable Name
// Compute roots of a quadratic equation.
// This assumes that (b^2-4*a*c) is positive.
temp = sqrt( b^2 - 4*a*c );
root[0] = ( -b + temp ) / ( 2 * a );
root[1] = ( -b - temp ) / ( 2 * a );

//C++ Example with a “Temporary” Variable Name Replaced with a Real Variable
// Compute roots of a quadratic equation.
// This assumes that (b^2-4*a*c) is positive.
discriminant = sqrt( b^2 - 4*a*c );
root[0] = ( -b + discriminant ) / ( 2 * a );
root[1] = ( -b - discriminant ) / ( 2 * a );

命名布林變數
Naming Boolean Variables

• done: 完成
• error: 錯誤
• found: 已找到
• success/ok: 已完成

status = true;
sourceFile = true;

statusOk = true;
sourceFileFound = ture;

• 優: 避免出現isStatus、isSourceFile這種鬼東西。
• 缺: if ( isError) 比 if (error)難懂一點點。

命名列舉型別
Naming Enumerated Types

1. 它是使用者定義型別: 命名要加前綴字
2. 它是常數: 命名要和常數一樣
3. 它是類別(有些語言(Java)支援這種用法)

enmu Color{ Color_Red, ...}
Color.Color_Red

這種情況，前綴詞就沒什麼用處。

命名常數
Naming Constants

const int FIVE = 5;

11.3 命名原則(慣例)的力量
The Power of Naming Conventions

為什麼要有命名原則    Why?
Why Have Conventions?

何時該使用命名原則    When?
When You Should Have a Naming Convention

正式的程度    How?
Degrees of Formality

寫程式的人數×程式大小×程式預估壽命=正式度

11.4 非正式命名原則(慣例)
Informal Naming Conventions

無關語言的一個公定原則
Guidelines for a Language-Independent Convention

特定語言的公定原則
Guidelines for Language-Specific Conventions

1. 變數代表什麼？
2. 用哪一種資料型態表示？
3. Scop多大?

11.5 標準前綴詞
Standardized Prefixes

1. 使用者定義型別縮寫
2. 語意前綴詞

使用者定義型別縮寫
User-Defined–Type (UDT) Abbreviation

語意前綴詞
Semantic Prefix

標準化前綴詞的優點
Advantages of Standardized Prefixes

11.6 建立易懂的短名稱
Creating Short Names That Are Readable

一般的縮寫原則
General Abbreviation Guidelines

同音縮寫
Phonetic Abbreviations

• skating = sk8ing ( at = 8 )
• highlight = hilite ( hight = hi, light = lite )
• before = b4
• execute = xqt

縮寫的心得
Comments on Abbreviations

11.7 要避免使用的名稱
Kinds of Names to Avoid