軟件開發目錄規範

目錄

• 軟件開發目錄規範

軟件開發目錄規範

爲了提升程序的可讀性與可維護性，咱們應該爲軟件設計良好的目錄結構，這與規範的編碼風格同等重要，簡而言之就是把軟件代碼分文件目錄。假設你要寫一個ATM軟件，你能夠按照下面的目錄結構管理你的軟件代碼：

ATM/
|-- core/
|   |-- src.py  # 業務核心邏輯代碼
|
|-- api/
|   |-- api.py  # 接口文件
|
|-- db/
|   |-- db_handle.py  # 操做數據文件
|   |-- db.txt  # 存儲數據文件
|
|-- lib/
|   |-- common.py  # 共享功能
|
|-- conf/
|   |-- settings.py  # 配置相關
|
|-- bin/
|   |-- run.py  # 程序的啓動文件，通常放在項目的根目錄下，由於在運行時會默認將運行文件所在的文件夾做爲sys.path的第一個路徑，這樣就省去了處理環境變量的步驟
|
|-- log/
|   |-- log.log  # 日誌文件
|
|-- requirements.txt # 存放軟件依賴的外部Python包列表，詳見https://pip.readthedocs.io/en/1.1/requirements.html
|-- README  # 項目說明文件