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

原文連結: https://darkblack01.blogspot.com/2012/10/code-complate-ii-27.html
移植時的最後更新日期: 2013-02-07T15:17:04.305+08:00

第七章 高品質常式
Hight-Quality Routines

//C++ Example of a Low-Quality Routine
viod HandlsStuff( CORP_DATA & inputRec, int crntQtr, EMP_DATA empRec, cougle & estimRevenue, double ytdRevenue, int screenX, int screenY, COLOR_TYPE & newColor, COLOR_TYPE & prevColor, StatusType & status, int expenseType)
{
 int i;
 for ( i = 0; i < 100; i++){
  inputRec.revenue[i] = 0;
  input Rec.expense[i] = corpExpense[ crntQtr ][i];
 }
 
 UpdateCorpDatabase ( empRec );
 estimRevenue = ytdRevenue * 4.0 / (double) crntQtr;
 newColor = prevColor;
 status = SUCCESS;

 if ( expenseType == 1){
  for( i = 0; i< 12; i++)
   profit[i] = revenue[i] - expense.type1[i];
 }
 else if ( expenseType == 2){
   profit[i] = revenue[i] - expense.type2[i];
 }
 else if ( expenseType == 3)
   profit[i] = revenue[i] - expense.type3[i];
 }

• 常式名稱不佳
• 常式沒有文件化
• 常式有一錯誤配置（子程序的布局不好）-參考31章
• 引數中的inputRec被修改。
• 讀寫全域變數
• 常式沒有單一目的
• 常式沒有注意防範錯誤資料
• 常式使用數個Magic Number
• 常式沒有使用所有參數
• 常式參數傳遞不正確：prevColor& 並沒有被更改。（應該設為const）
• 常式參數過多
• 常式參數順序混亂，沒有註釋（文件化）

• 避免重覆
• 容易進行 開發、除錯、文件化、維護

7.1 建立式的充份理由
(Valid Reasons to Create a Routine)

1. 提取重覆程式碼
2. 相同程式碼→基礎類別
3. 特別程式碼→衍生類別

1. 相同的程式碼移到新的常式內
2. 特別程式碼呼叫這個常式

1. 確保指標的操作正確
2. 確定替換指標行為時完整

看似過於簡單而無法置入沒有必要寫成 常式的作業操作

//Pseudocode Example of a Calculation
points = deviceUnits * (POINTS_PER_INCH/DeviceUnitsPerInch())

//Pseudocode Example of a Calculation Converted to a Function
Function DeviceUnitsToPoints ( deviceUnits Inter ): Inter
DeviceUnitsToPoint = deviceUnits * (POINTS_PER_INCH/DeviceUnitsPerInch())
End Function

//Pseudocode Example of a Function Call to a Calculation Function
points = DeviceUnitsToPoints( deviceUnits )

• 易於閱讀
• 自我文件化
• 重覆使用

7.2 常式層次的設計
(Design at the Routine Level)

Get退休日期( Get年紀( Get生日() ) );

Update( Get資料() )
Print( Get資料() )

void 把長頸鹿放進冰箱()
{
    把冰箱打開();
    把長頸鹿放進去();
    把冰箱關起來();
}

void 使用者註冊過程()
{
    輸入名字();
    輸入生日();
    輸入密碼();
    確認密碼();
}

void 輸入名字();
void 輸入生日();
void 輸入密碼();
void 確認密碼();

void fun(int a)
{
    switch(a)
    {
        case 1:  functionOne();   break;
        case 2:  functionTwo();   break;        
        case 3:  functionThree(); break;
        default: functionFour();  break;
    }
}

fun(1);
fun(2);
fun(3);
fun(4); 

functionOne();
functionTwo();
functionThree();
functionFour();

fun(EventTrig());

7.3 良好的常式名稱
(Good Routine Names)

PrintDocument();
CalcMonthlyRevenues();
CheckOrderInfo();
RepaginateDocument();

document.Print();
monthlyRevenues.Calc();
orderInfo.Check();
document.Repaginate();

employee.id.Get();
dependent.GetId();
supervisor();
candidate.id();

7.4 常式的長度限制
(How Long Can a Routine Be)

7.5 如何使用常式參數
(How to Use Routine Parameters)

Ada Example of Parameters in Input-Modify-Output Order
procedure InverMatrix(
originalMatrx: in Matrix;
resultMatrix: out Matrix
);
...

procedure ChangeSentanceCase(
desiredCase: in StringCase;
setance: in out Sentance
);
...

procedure PrintPageNumber(
pageNumber: in Integer;
status: out StatusType
);

C++ Example of Defining Your Own In and Out Keywords
#define IN
#define OUT
void InverMatrix(
IN Matrix originalMatrix,
OUT Matrix *resultMatrix
);
...

void ChangeSentenceCase(
IN StringCase desiredCase,
IN OUT Sentence *sentenceToEdit
);
...

void PrintPageNumber(
IN int pageNumber,
OUT StatusType &status
)

Java Example of Improper Use of Input Parameters
int Sample( int inputVal ){
 inputVal = inputVal * CurrentMultiplier( inputVal );
 inputVal = inputVal + CurrentAdder( inputVal );
 ...
 return inputVal;
}

Java Example of Improper Use of Input Parameters
int Sample( int inputVal ){
 int workingVal = inputVal;
 workingVal = workingVal * CurrentMultiplier( workingVal );
 workingVal = workingVal + CurrentAdder( workingVal );
 ...
 return workingVal;
}

1. 建立臨時物件，填值
2. 將物件傳入常式
3. 將物件成員取出使用

Visual Basic Example of Explicitly Identifying Paramaters
Private Function Distance3d(_
    ByVal xDistance As Coordinate, _
    ByVal yDistance As Coordinate, _
    ByVal zDistance As Coordinate _
)
...
End Function
...
Private Function Velocity(_
    ByVal latitude As Coordinate, _
    ByVal longitude As Coordinate, _
    ByVal elevation As Coordinate _
)
    ...
    Distance = Distance3d( xDistance := latitude, yDistance :=
        longitude, _zDistance := elevation)
    ...
End Function

7.6 函式使用的特殊考量因素
(Special Considerations in the Use of Functions)

使用函式和程序的時機
(When to Use a Function and When to Use a Procedure)

if (report.FormatOutput(formattedReport) = Success) then ...

• 常式的主要目的
• 格式化輸出
• 常式名稱report.FormatOutput()

report.FormatOutput( formattedReport, ourputStatus)
if (outputStatus = Success) then ...

• 常式呼叫
• 狀態測試

outputStatus = report.FormatOutput(formattedReport)
if (outputStatus = Success) then ...

設定函式的傳回值
(Setting the Function's Return Value)

• 確定在各稱情況下都會有回傳值
• 開頭將回傳值初始化

7.7 巨集常式和內嵌常式
(Macro Routines and Inline Routines)

#define Cube( a ) a*a*a

#define Cube( a ) (a)*(a)*(a)

#define Cube( a ) ((a)*(a)*(a))

#define Lookup Entry( key, index ) \
index = (key - 10) /5; \
index = min( index, MAX_INDEX ); \
index = max( index, MIN_INDEX );
...
for ( entryCount = 0; entryCount < numEntries; entryCount++ )
LookupEntry( entryCount, tableIndex[ entryCount ]);

#define Lookup Entry( key, index ) {\
index = (key - 10) /5; \
index = min( index, MAX_INDEX ); \
index = max( index, MIN_INDEX ); \
}
...
for ( entryCount = 0; entryCount < numEntries; entryCount++ )
LookupEntry( entryCount, tableIndex[ entryCount ]);

巨集常式的使用限制（Effective C++有提到）
(Limitations on the Use of Macro Routines)

//Ex.h
class Ex
{
public:
    void Display();
}

//Ex.cpp
void Ex::Display()
{
    std::cout << "I am Ex class" << endl;
}

//Ex.h
class Ex
{
public:
    void Display();
}

inline void Ex::Display()
{
    std::cout << "I am Ex class" << endl;
}

• 增加效率，避免常式呼叫的負擔

• 違反封裝，因為該常式定義於標頭檔內，讓使用標頭檔的程式設計師都看得見程式碼。
• 只要呼叫該inline常式的地方，就會增加整體程式碼的長度，這可能帶來自身的問題。
• 在「犧牲封裝改善效能」這件事上，若沒什麼效益，其實並不需要這樣做，因為會降低程式碼的品質，只是會讓code更難管理。