1. 程式人生 > 其它 >軟體開發書寫規範

軟體開發書寫規範

軟體開發目錄規範

  • 目錄規範並無固定的要求 主要符合清晰可讀即可

bin資料夾

bin資料夾
	存放一系列啟動檔案(當啟動檔案很少或者只有一個的時候也可以直接寫在外面)
    	start.py

conf資料夾

conf資料夾
	存放一些列配置檔案
    	settings.py (一般情況下該檔案內的變數名都是大寫)

lib資料夾

lib資料夾
	存放公共的功能
    	common.py

db資料夾

db資料夾
	存放資料相關檔案
    	userinfo.txt

log資料夾

log資料夾
	存放日誌記錄檔案
    	log.txt

core資料夾

core資料夾
	存放專案核心程式碼檔案
    	src.py

readme檔案

readme檔案
	存放說明相關資訊 (類似於產品說明書  廣告  章程)

requirements.txt

存放專案所需的第三方模組及版本號

為什麼要規範軟體開發目錄

# 其實設計專案目錄結構,就和我們寫程式碼風格一樣,屬於個人風格問題。

# 但是規範化能夠更好的控制程式結構,讓程式具有更高的可讀性

優點:
1.可讀性高: 不熟悉這個專案的人,一眼就能看懂目錄結構,知道程式啟動指令碼是那個,測試目錄在哪裡,配置檔案在哪裡等等。從而快速的瞭解專案
2.可維護性高:定義好組織規則後,維護者就能很明確的知道,新增的那個檔案和程式碼應該放在什麼目錄之下。這樣專案結構就不會混亂,可以良好的組織軟體。

# 所以規範的軟體開發目錄是很有必要的!!!

上述就是一個比較完成的軟體開發目錄