程式碼重構：檔案相關變數命名約定

wry2008wry發表於2020-09-28
變數

檔案相關變數的命名約定：

    進行檔案操作時，我們需要定義相關的一些變數，比如目錄、檔名、全路徑、副檔名。我在寫程式碼是使用以下的變數命名約定：比如有一個配置檔案，它的全路徑變數就命名為config_path、它所在的目錄就是config_directory、配置檔案本身直接用fd_config。

 

具體如下（xxx表示具體的業務名，如配置檔案config、語料檔案courpus）：

fd_xxx表示檔案本身，fd是檔案描述符（file descriptor），來自於c語言習慣，認可度比較高，這樣寫大家都懂，如：“fd_config”
xxx_file_name表示後字尾的檔名，如：“a.config”

xxx_file_name_without_extension

表示不帶字尾的檔名，因為平時也用得比較少，所以名字長點無所謂，如："a"
xxx_extension表示副檔名，如：“config”；
xxx_directory表示檔案的目錄，如："/home/wangrenyong/app"；
xxx_holder表示檔案所屬的那一級資料夾，如："app"；
xxx_path表示全路徑，如："/home/wangrenyong/app/a.config"；

小細節：

如果是目錄，後面就不要加"/"了，因為在以後拼全路徑時，format中的格式字串會出現分隔符"/"，比較直觀的看出這是一個路徑，如下圖：

相關文章