軟體開發目錄規範

為了提高程式的可讀性與可維護性，我們應該為軟體設計良好的目錄結構，這與規範的編碼風格同等重要。軟體的目錄規範並無硬性標準，只要清晰可讀即可，假設你的軟體名為foo，目錄結構如下

Foo/
|-- core/
|   |-- core.py
|
|-- api/
|   |-- api.py
|
|-- db/
|   |-- db_handle.py
|
|-- lib/
|   |-- common.py
|
|-- conf/
|   |-- settings.py
|
|-- run.py
|-- setup.py
|-- requirements.txt
|-- README

解釋如下:

​ • core/: 存放業務邏輯相關程式碼

​ • api/: 存放介面檔案，介面主要用於為業務邏輯提供資料操作。

​ • db/: 存放操作資料庫相關檔案，主要用於與資料庫互動

​ • lib/: 存放程式中常用的自定義模組

​ • conf/: 存放配置檔案

​ • run.py: 程式的啟動檔案，一般放在專案的根目錄下，因為在執行時會預設將執行檔案所在的資料夾作為sys.path的第一個路徑，這樣就省去了處理環境變數的步驟

​ • setup.py: 安裝、部署、打包的指令碼。

​ • requirements.txt: 存放軟體依賴的外部Python包列表。

​ • README: 專案說明檔案。

除此之外，有一些方案給出了更加多的內容，比如LICENSE.txt,ChangeLog.txt檔案等，主要是在專案需要開源時才會用到，請讀者自行查閱。

關於README的內容，這個應該是每個專案都應該有的一個檔案，目的是能簡要描述該專案的資訊，讓讀者快速瞭解這個專案。它需要說明以下幾個事項:

1、軟體定位，軟體的基本功能；

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

3、簡要的使用說明；

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

5、常見問題說明。