如何在linux中建立特定的指令碼註釋資訊

三思博客發表於2024-04-21

如何在linux中建立特定的指令碼註釋資訊

當然,以下是詳細步驟在 CentOS 7 系統中建立一個新的 shell 指令碼模板並在 Vim 編輯器中配置自動載入模板的完整過程:

步驟1:建立 shell 指令碼模板

首先,開啟終端並建立一個模板檔案,我們將其命名為 .bash_script_template 並放置在使用者的家目錄下:

echo -e '#!/bin/bash\n#\n#********************************************************************\n#Author:          nwq\n#QQ:              3078499367\n#Date:            `date +%Y-%m-%d`\n#FileName:       ${filename}\n#URL:             http://www.sansi.fun\n#Description:     The test script (to be replaced with actual description)\n#Copyright (C):   2024 All rights reserved\n#********************************************************************\n' > ~/.bash_script_template

這裡的 ${filename} 是一個佔位符,實際上在 Vim 中並不會自動替換為實際檔名。如果你希望每次新建指令碼時都能自動更新日期和檔名,這一步可能需要進一步的 Vim 指令碼處理。

步驟2:編輯 Vim 配置檔案

接下來,我們需要編輯 Vim 的配置檔案 .vimrc,如果沒有這個檔案,你需要先建立它:

touch ~/.vimrc

然後用 Vim 開啟它進行編輯:

vim ~/.vimrc

步驟3:在 .vimrc 檔案中新增自動載入模板的命令

.vimrc 檔案中新增以下一行內容,以便每當新建一個以 .sh 結尾的檔案時,Vim 會自動讀取並插入模板內容:

autocmd BufNewFile *.sh 0r ~/.bash_script_template

儲存並退出 Vim(鍵入 :wq 或點選右上角選單欄的“寫入”按鈕,然後按 Esc 鍵並鍵入 :q 來退出)。

步驟4:驗證模板是否生效

重新啟動 Vim,然後嘗試建立一個新的 shell 指令碼:

vim new_script.sh

此時你應該能看到模板內容已經自動載入到了新檔案中。

需要注意的是,${filename} 佔位符在這裡不會自動替換為實際檔名 "new_script.sh",這是一個 Vim 模板功能本身的侷限,除非你自己編寫 Vim 指令碼來實現這一動態替換。如果你只需要固定的頭部資訊,那麼目前的設定已經足夠。

相關文章