12 軟體專案的目錄設計規範

2021-10-10 06:34:53 字數 984 閱讀 8525

為什麼要設計好目錄結構

可讀性高

可維護性高

目錄組織方式

假設專案名為foo,比較好的最方便快捷目錄結構如下:

foo/|-

-bin

/# 啟動檔案、管理指令碼||

-- foo||

-- foo/

# 核心**||

-- tests/

# 測試**||

|-- __init__.py||

|-- test_main.py||

||-- __init__.py||

-- main.py||

-- conf/

# 配置檔案目錄||

-- docs/||

-- abc.rst||

-- setup.py # 安裝程式|-

- requirements.txt # 環境依賴|-

- readme # 專案說明文件

requirements.txt

requirements內容:

alex-sayhi==1.0.0

asgiref==3.2.10

attrs==19.3.0

backcall==0.1.0

bleach==3.1.0

certifi==2020.6.20

chardet==3.0.4

colorama==0.4.3

comtypes==1.1.7

cycler==0.10.0

生成及使用requirements

pip freeze > requirents.txt	# 將系統依賴包匯出

pip install -r requirements.txt # 安裝所有依賴包

軟體專案開發目錄規範

所謂的軟體專案開發目錄規範,就是根據不同檔案的特點特徵,分門別類,也就是根據功能特點劃分為不同的分組,和我們日常生活中的文字目錄類似。在日常生活中,我們經常會遇到東西丟三落四,並且不同的東西都放到同乙個容器內在尋找某乙個物品的時候就會很麻煩,其實在軟體開發中也是一樣,如果不對不同功能的檔案進行分類,...

軟體產品設計規範書 一

軟體設計書五花八門,根據不同的專案選址一種吧。呵呵!物件導向軟體設計說明書 1概述 1.1系統簡述 對系統要完成什麼,所面向的使用者以及系統執行的環境的簡短描述,這部分主要 於需求說明書的開始部分。1.2軟體設計目標 這部分論述整個系統的設計目標,明確地說明哪些功能是系統決定實現而哪些時不準備實現的...

軟體定義網路基礎 REST API的設計規範

rest api是基於http協議進行設計的,由http動詞 uri組成 文件是資源的單一表現形式 集合是資源的乙個容器 目錄 可以向裡面新增 資源 文件 客戶端管理的乙個資源庫,可以向倉庫中新增資源 或者刪除資源,或者從倉庫中獲取資源 可以執行乙個方法,支援引數輸入,結果返 回。文件 docume...