軟件目錄結(jié)構(gòu)規(guī)范

軟件開發(fā)規(guī)范

一、為什么要設(shè)計好目錄結(jié)構(gòu)?

1.可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結(jié)構(gòu)，知道程序啟動腳本是哪個，測試目錄在哪兒，配置文件在哪兒等等。從而非常快速的了解這個項目。

2.可維護(hù)性高: 定義好組織規(guī)則后，維護(hù)者就能很明確地知道，新增的哪個文件和代碼應(yīng)該放在什么目錄之下。這個好處是，隨著時間的推移，代碼/配置的規(guī)模增加，項目結(jié)構(gòu)不會混亂，仍然能夠組織良好。

二、目錄組織方式

關(guān)于如何組織一個較好的Python工程目錄結(jié)構(gòu)，已經(jīng)有一些得到了共識的目錄結(jié)構(gòu)。

假設(shè)你的項目名為Notebook

Notebook/

|-- bin/ 存放項目的一些可執(zhí)行文件，當(dāng)然你可以起名script/之類的也行，但bin/更直觀。易懂

| |-- __init__

|　 |-- start.py 寫啟動程序

|

|-- core/ 存放項目的所有源代碼(核心代碼)。(1) 源代碼中的所有模塊、包都應(yīng)該放在此目錄。不要置于頂層目錄。?(2) 其子目錄tests/存放單元測試代碼； (3) 程序的入口最好命名為main.py| |-- tests/

| | |-- __init__.py

| | |-- test.main.py

| |

| |-- __init__.py

| |-- test_main.py| 存放核心邏輯

|

|-- conf/ 配置文件

| |-- __init__.py

| |-- setting.py 寫上相關(guān)配置

|

|---db/ 數(shù)據(jù)庫文件

| |--db.json 寫數(shù)據(jù)庫文件

|

|-- docs/ 存放一些文檔

|

|-- lib/ 庫文件，放自定義模塊和包

| |-- __init__.py

| |-- common.py 放常用的功能

|

|-- log/ 日志文件

| |-- access.log 寫上日志

|

|-- README 項目說明文件

注：運行程序時，在bin目錄下執(zhí)行start.py代碼，不可以直接執(zhí)行core下的模塊。

README相關(guān)

使用過開源軟件的朋友們都知道README可以給軟件的使用帶來很大的幫助，包括軟件介紹、功能定位、安裝啟動使用方法、有建議或bug怎么聯(lián)系作者等，其必要性和重要性不言而喻。

因此每一個項目都應(yīng)該有README說明，好的README應(yīng)該至少包括以下幾方面的內(nèi)容：

軟件的簡要介紹、功能定位、適用場景等

軟件的安裝、環(huán)境依賴、啟動方法、常見使用命令(使用說明)等

代碼的目錄結(jié)構(gòu)說明

常見問題說明

遇到建議或bug如何聯(lián)系作者或項目組

如果再編寫的更詳細(xì)，可以考慮簡述軟件的基本原理。這方面最好的參考就是開源軟件的README，如nginx，redis等。

總結(jié)

以上是生活随笔為你收集整理的python安装目录结构_python软件目录结构规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。