Shell函數編寫規範

一、函數命名規範

函數名應該簡潔而明確，可以由英文字母、數字、下劃線組成，應該以字母開頭，並且不應該與Shell的保留字衝突。建議使用小寫字母，以便與環境變數作區分。例如：

function my_function() {
    # code here
}

若函數名由多個單片語成，可以使用駝峰命名法或下劃線分隔符，但**不建議使用中劃線分隔符**，以免被誤認為是參數選項。例如：

function myFunctionName() {
    # code here
}

function my_function_name() {
    # code here
}

二、函數調用規範

在Shell腳本中調用函數時，可以直接使用函數名進行調用。若函數有返回值，可以使用變數接收函數的返回值，例如：

function return_something() {
    local str="Hello World"
    return "這是函數的返回值：$str"
}

result=$(return_something)
echo $result

三、函數參數規範

函數可以具有參數，其中$1、$2、$3等表示函數的第1個、第2個、第3個參數，$#表示函數的參數個數，$0表示函數名，例如：

function my_function() {
    echo "這是第1個參數：$1"
    echo "這是第2個參數：$2"
    echo "這是第3個參數：$3"
    echo "參數個數為：$#"
    echo "函數名為：$0"
}

my_function arg1 arg2 arg3

四、代碼注釋規範

函數中的代碼應該加上注釋，以便提高代碼的可讀性和可維護性。注釋應該清晰明了，可以包含函數的參數、返回值、功能、實現等信息。例如：

# 這是一個示例函數，接收兩個參數並輸出它們之間的範圍
# 參數1：$1，表示下限
# 參數2：$2，表示上限
# 返回值：無
function range() {
    local min=$1
    local max=$2
    for i in $(seq $min $max); do
        echo $i
    done
}

五、錯誤處理規範

函數在執行過程中可能會出現各種錯誤，例如參數錯誤、文件不存在等。為了提高函數的健壯性，應該加上錯誤處理機制，例如：

# 這是一個示例函數，接收一個文件名作為參數，如果文件不存在就輸出錯誤信息並返回1
# 參數1：$1，表示文件名
# 返回值：0表示文件存在，1表示文件不存在
function check_file_exist() {
    local file=$1
    if [ ! -f $file ]; then
        echo "文件不存在：$file"
        return 1
    fi
    return 0
}

六、內置函數禁止覆蓋規範

Shell自帶許多內置函數，例如echo、cd、rm等，為了防止覆蓋這些函數，應該避免使用和這些函數相同的函數名。如果確實需要使用內置函數的同名函數，可以使用命令來調用內置函數，例如：

function echo() {
    command echo "這是自定義的echo函數"
}

echo "hello world"  # 調用自定義的echo函數
command echo "hello world"  # 調用原生的echo函數

七、局部變數聲明規範

為了防止變數名衝突和提高代碼的可維護性，應該在函數中顯式地聲明局部變數，並使用local關鍵字進行聲明。例如：

function my_function() {
    local var1=1
    local var2=2
    echo "var1=$var1 var2=$var2"
}

my_function

八、代碼縮進規範

為了提高代碼的可讀性和可維護性，應該在代碼中使用適當的縮進，使代碼結構清晰。一般來說，每個代碼塊都應該縮進4個空格，或者一個TAB鍵的距離。例如：

function my_function() {
    for i in $(seq 1 10); do
        if [ $i -eq 5 ]; then
            echo "i等於5"
        else
            echo "i不等於5"
        fi
    done
}

my_function

九、代碼風格規範

為了提高代碼的可讀性和可維護性，應該遵循一定的代碼風格規範，例如：

• 代碼縮進應該規範，一般使用4個空格或TAB鍵。
• 代碼塊應該使用`{}`進行包裹，且左括弧應該放在行末，右括弧應該放在新的一行。
• 代碼中應該避免使用無用的空格和空行。
• 代碼中應該盡量使用雙引號，防止變數的意外替換。

下面是一個符合代碼風格規範的示例：

function my_function() {
    local var1="hello"
    local var2="world"
    if [ $var1 = "hello" ]; then
        echo "$var1 $var2"
    fi
}

my_function