python 軟體目錄規範-技術-拾貝文庫網

1.可讀性高: 不熟悉這個專案的程式碼的人，一眼就能看懂目錄結構，知道程式啟動指令碼是哪個，測試目錄在哪兒，配置檔案在哪兒等等。

從而非常快速的瞭解這個專案。

python軟體目錄規範 標籤：access   test   clear   程式   邏輯   軟體開發   log   設計   內容     軟體目錄結構規範 軟體開發規範 一、為什麼要設計好目錄結構? 1.可讀性高:不熟悉這個專案的程式碼的人，一眼就能看懂目錄結構，知道程式啟動指令碼是哪個，測試目錄在哪兒，配置檔案在哪兒等等。

從而非常快速的瞭解這個專案。

2.可維護性高:定義好組織規則後，維護者就能很明確地知道，新增的哪個檔案和程式碼應該放在什麼目錄之下。

這個好處是，隨著時間的推移，程式碼/配置的規模增加，專案結構不會混亂，仍然能夠組織良好。

二、目錄組織方式 關於如何組織一個較好的Python工程目錄結構，已經有一些得到了共識的目錄結構。

假設你的專案名為ATM ATM/ |--bin/存放專案的一些可執行檔案，當然你可以起名script/之類的也行，但bin/更直觀。

易懂 ||--__init__|　|--start.py寫啟動程式 | |--core/存放專案的所有原始碼(核心程式碼）。

(1)原始碼中的所有模組、包都應該放在此目錄。

不要置於頂層目錄。

 (2)其子目錄tests/存放單元測試程式碼；(3)程式的入口最好命名為main.py。

||--tests/|||--__init__.py|||--test.main.py|| ||--__init__.py ||--test_main.py|存放核心邏輯 | |--conf/配置檔案 ||--__init__.py ||--setting.py寫上相關配置||---db/資料庫檔案 ||--db.json寫資料庫檔案| |--docs/存放一些文件| |--lib/庫檔案，放自定義模組和包||--__init__.py||--common.py放常用的功能||--log/日誌檔案||--access.log寫上日誌||--__init__.py |--README專案說明檔案注：執行程式時，在bin目錄下執行start.py程式碼，不可以直接執行core下的模組。

關於README的內容 這個我覺得是每個專案都應該有的一個檔案，目的是能簡要描述該專案的資訊，讓讀者快速瞭解這個專案。

它需要說明以下幾個事項: 軟體定位，軟體的基本功能。

執行程式碼的方法:安裝環境、啟動命令等。

簡要的使用說明。

程式碼目錄結構說明，更詳細點可以說明軟體的基本原理。

常見問題說明。

python軟體目錄規範標籤：access   test   clear   程式   邏輯   軟體開發   log   設計   內容   原文地址：https://www.cnblogs.com/ceason/p/11644955.html 上一篇：常用的html特殊符號編碼下一篇：windows快捷啟動命令 搜索 最新發布： win11安全模式怎麼進入 win11下載卡在0%不動怎麼辦 win11下載的軟體怎麼移到桌面 win11正式版如何安裝安卓app 膝上型電腦如何重灌系統win11 重灌系統win11後c盤會清空嗎 win11重灌系統步驟和詳細教程 臺式電腦系統安裝步驟圖解win11 win11下載軟體被阻止怎麼辦 升級win11後怎麼退回win10 win10升級win11方法教程 win10瀏覽器打不開網頁但能上網怎麼辦 win10u盤安裝系統詳細步驟 win10開機黑屏只有滑鼠怎麼辦 win10開機慢怎麼設定優化