Perl 最佳實務(節選) --- 03

標籤：

第三章：命名慣例 零貳三.

構成標示符時要使用文法模板。

l        變數以名詞命名，前面不加或再加上多個形容詞：

variable → [adjective _ ]* noun

l        hash和數組：

look-variable → [adjective _ ]* noun preposition 零貳肆.

根據相關測試替布爾值命名。 零貳伍.

把儲存引用的變數標上_ref尾碼。 零貳陸.

數組以複數命名，而散列以單數命名。

Perl有可用的格式化工具：perltidy。

網址：http://perltidy.sourceforge.net 零貳柒.

以底線把多詞標識符中的單詞分隔開來。 零貳捌.

以大小寫區分不同程式組件。

l        子程式、方法、變數、加標籤的自變數的名稱都使用小寫。

l        包和類名使用混合的大小寫。

l        常量則使用大寫。 零貳玖.

以首碼作為縮寫。

注意：當你以首碼作為標識符的縮寫時，保留最後的輔音字母是可以接受的（通常也是不可少的），特別是輔音字母是複數尾碼時。 零三零.

只在意義明確時才縮寫。 零三壹.

名稱中避免使用模糊的詞。

我們拒絕使用“last”。例如，名為$last_record的變數可能是指最近處理過的記錄（此時應該稱為$prev_record），但是也可能指列表中最終的記錄（此時應該稱為$final_record）。

其他應避免使用的常見詞如下：

l        “left”（方向 vs. 剩餘之物）

l        “right”（另一方向vs. 正確vs. 權利）

l        “no”（否定vs. 數位縮寫）

l        “contract”（縮小vs. 合約）

l        “record”（最佳成績vs.資料集vs. 記錄）

l        “second”（第二vs. 時間單位）

l        “bases”（幾座基地vs. 幾項基礎） 零三貳.

“只供內部使用的”子程式要在開始處加上底線。

我們拒絕使用“last”。例如，名為$last_record的變數可能是指最近處理過的記錄（此時應該稱為$prev_record），但是也可能指列表中最終的記錄（此時應該稱為$final_record）。

其他應避免使用的常見詞如下：

l        “left”（方向 vs. 剩餘之物）

l        “right”（另一方向vs. 正確vs. 權利）

l        “no”（否定vs. 數位縮寫）

l        “contract”（縮小vs. 合約）

l        “record”（最佳成績vs.資料集vs. 記錄）

l        “second”（第二vs. 時間單位）

l        “bases”（幾座基地vs. 幾項基礎）

Perl 最佳實務(節選) --- 03