Python 入門之 軟件開發規范
1、軟件開發規范 -- 分文件
(1)為什么使用軟件開發規范:
當幾百行--大幾萬行代碼存在于一個py文件中時存在的問題:
不便于管理 修改
可讀性差
加載速度慢
這時可以使用軟件開發規范,規范項目目錄結構,規范代碼,遵循PEP8規范,能夠更加清晰,合理的開發。
(2)軟件開發規范 -- 約定俗稱
<1> bin -- 啟動文件 (啟動接口)
start.py 項目啟動
<2> lib -- 公共文件 (大家需要的功能)
commom.py 放置一些常用的公共組件函數,像是服務于整個程序中的公用的插件。(加密,序列化,日志等功能)
<3> conf -- 配置文件 (靜態文件)變量
settings.py 放置一些項目中需要的靜態參數,比如文件路徑,數據庫配置,軟件的默認設置等。
<4> core -- 主邏輯 (核心)
src.py 主要存放的是核心功能函數
<5> db -- 用戶相關數據 (賬號和密碼等文件)
register.py 用戶的相關數據
<6> log -- 日志 (記錄主要信息,記錄開發人員的行為)
access.log 存儲日志文件
<7> README文件 簡要描述該項目的信息
文件中要說明幾個注意事項:
軟件的定位,軟件的基本功能。
運行代碼的方法,安裝環境,啟動命令等
簡要的使用說明
代碼目錄結構說明,更詳細點可以說明軟件的基本原理
常見問題說明
軟件開發規范:
"""
blog
├─ bin
│ └─ starts.py 啟動文件
├─ conf
│ └─ settings.py 配置文件
├─ core
│ └─ src.py 邏輯文件
├─ db
│ └─ register 數據文件
├─ lib
│ └─ common.py 公共文件
└─ log
│ └─ logg.log 日志文件
├─ README.md 使用手冊
"""
更多文章、技術交流、商務合作、聯系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號聯系: 360901061
您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點擊下面給點支持吧,站長非常感激您!手機微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對您有幫助就好】元
