程式規範示例

2022-05-10 17:46:57 字數 1092 閱讀 4047

1 為什麼需要進行程式規範?

可讀性可維護性

2 程式如何規範?

舉個簡單的例子,如果我們要建立乙個foo專案

foo/

|--bin/

| |--foo

||--foo/

| |--tests/

| | |--__init__.py

| | |--test_main.py

| |

| |--__init__.py

| |--main.py

||--docs/

| |conf.py

| |abc.rst

||--setup.py

|--requirments.txt

|--readme

3 分別是什麼意思?

bin/:存放可執行檔案。

foo/:存放專案的所有源**。所有模組都應該放到此目錄中。不要置於頂層目錄

子目錄test/單元存放測試**

程式入口命名為:main.py

docs/:存放其他文件

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

requirement.txt:存放軟體依賴的外部python目錄

readme專案說明檔案

4 readme中應該包括些什麼?

軟體定位,主要功能

執行**方法:1 安裝環境 2 啟動命令

簡要使用說明

**目錄說明,說明軟體的基本原理

常見問題說明

加相對路徑,讓你的程式能夠在所有裝置上都可以使用

新需求:模擬實現atm+購物車的功能

額度15000

實現購物**,買東西加入購物車,呼叫信用卡介面

可以提現,手續費5%

支援多賬戶登陸

賬戶間相互轉賬

記錄每月日常消費流水

提供還款介面

atm記錄操作日誌

提供管理介面,包括新增賬戶、使用者額度、凍結賬戶等

使用者認證用裝飾器

程式規範 命名規範

這裡列舉我自己的命名規則,網上很多,但是這個是我目前自己的命名規範 每個單詞的首字母大寫,一般用名詞形式 如 circle goodobject highschool stringlist memorypool verylargebuffer 顯然,所有命名的乙個基本要求 顧名思義,通過名字,能夠反...

git ignore檔案規範與示例

在 git 中如果想忽略掉某個檔案,不讓這個檔案提交到版本庫中,可以使用修改根目錄中.gitignore檔案的方法 如果沒有這個檔案,則需自己手工建立此檔案 下面這個可以直接拿來用,基本包含了常用的 ide target sts apt generated classpath factorypath...

MapReduce 程式設計規範及示例編寫

mapreduce 程式設計規範及示例編寫 1.程式設計規範 程式設計規範 5 map 方法 maptask 程序 對每乙個呼叫一次 7 reducer 的業務邏輯寫在 reduce 方法中 8 reducetask 程序對每一組相同 k 的組呼叫一次reduce 方法 10 整個程式需要乙個 dr...