# 项目编程基本原则
## 文档及代码编辑的注意事项
### 进度汇报
**查文档和编程任务是否符合。**
首先自查一遍文档，每个编程任务是否符合文档上编程任务的要求---请在进度表中标示【自查：符合 或 不符合】， ，
**查命名问题，函数框架，函数名称，和变量名规范**
(2)按我们前两天讨论的，主函数框架、函数关系调用图、函数名称与变量名称规范化等方面回复【已优化完成，未优化完成】
### 主函数框架示例：
```python
# 需要导入的库
from tkinter import scrolledtext # 下拉框
from tkinter import END # 下拉框自动下拉到最后一行
from pymouse import PyMouse # 模拟鼠标自动点击
import tkinter as tk # UI界面
import threading # 多线程任务
import win32gui # 获取扫雷窗口信息
import random # 随机数
import time # 应用sleep函数睡眠
"""按照上宽下窄的方式排列引用"""
"""
所有的系统库或第三方库，一次性引出，避免因为确少库而导致运行不了。
如果是自写的模块，可以在函数前引出
"""
#方式1--在文件中定义全局变量，加载全局变量定义文件（如果全局变量实在太多）
from setting import * # （ ）
# setting中定义了哪些全局变量及其定义
#方式2--直接定义全局常量和变量（一般多）
全局常量
GLOBAL ... ... # 常量用大写，大写字母下划线链接
全局变量
Init_Matrix ... ... # 全局变量首字母大写
"""按照上宽下窄的方式排列引用"""
注释标准：
就近对齐规则
print("数据集中图片的个数:", len(data_list)) # 打印图片数据集中图片的个数
print("第一个图片数组的形状:", data_list[0].shape) # 打印第一个图片数组的形状
print("第一个图片数组的内容:\n", data_list[0]) # 打印第一个图片数组的内容
return data_list # 返回加载成功的图像数据列表
###########
'此处说明是放函数定义的地方'
###########
# 主控函数, 将函数定义拷贝到main函数上面，
if __name__ == '__main__':
pass
###########
'此处说明是函数调用的地方'
###########
"""
要求主函数框架单独运行不报错
"""
```
```python
# 文档贴函数提示说明 如下图所示
###########################################################################
# 以func1()[编程章节]==>func2()[编程章节]的方式说明调用当前函数要用的前述函数。
set_random_state()[5.1]==>create_boards()[5.4]==>show_window()[5.4]
```
### 根据不同情况不同的贴程序方法
```python
# 情况一
##### 第一次出现init初始化方法需要写全 #####
##### 在类里面增添方法，需要将类名写出，再写方法 #####
X2:
class MineSweeper: # 建立扫雷类
def __init__ (self): # 第一次出现init初始化方法需要写全，
def f2():
pass
# 情况二
##### 如果函数实在太多，需要标出函数调用关系图，同时将贴合编程要求的程序给出 #####
X3: # f1(), f2(), f3(), f4(), ..., f10() 本段仅给出f4(), 完整的在[位置]（可以在文档末尾建立附录）。
Class Class_some
...
def f4(): 体现核心功能的函数给出。
pass
# 情况三
##### 如果需要在后续编程章节中扩充原有的功能，可以扩写函数，#####
##### 而且不要出现已经出现过的代码，已经出现过的代码用...代指 #####
X4: 【友好阅读性原则；最小重复代码原则；递增式代码表达原则；界面元素处理与业务逻辑完全分开原则】
class MineSweeper: # 扩展扫雷类--在X2基础上进一步定义
# _init_ (self), f2(), 一并处理
def _init_ (self): #在原函数基础上增加/调整
...
self.par = "example"
def f3():
...
def f4():
...
每个函数不超一页，原则上就是半页。
```
## 项目编程的普遍要求
### GUI界面和数据结构分开
借用前后端分离的架构模式。
GUI界面负责处理用户界面的展示和交互，
将GUI界面负和数据结构分为两个独立的部分，
### 代码命名规则：
在Python中， ，
全局变量：首字母大写单词之间用下划线分隔。
变量和函数名： ， （ ） ：
常量： ， ：
类名： （ ） ， ， ：
模块名： ， ：
- 首先是做好程序的优化，即做好程序函数的封装。 每个函数的函数名尽可能符合文档的编程任务及其要求--要让读者看到函数名就能想到编程任务，这样会更易于理解。
- 函数调用关系图的理解是正确的，就是要有一张全局关系图。
- 正确理解X1、X2、X3、X4和X5。通常， ， ， ， ，
- 注意： ， ， ， ， ， ，
### 函数调用关系图：
函数调用图（ ） ，
在函数调用图中，函数被表示为节点，函数之间的调用关系被表示为边。每个函数调用都会生成一个新的节点和一条连接调用者和被调用者的边。函数调用图可以是有向图或无向图，具体取决于函数调用的方向性。
调用图可以用软件生成。
### 项目文件应包含(后续规范)
项目应该包含以下基本文件：
1. README.md： ，
2. LICENSE： ，
3. .gitignore： ， ，
4. requirements.txt： ， ，
5. setup.py 或者 setup.cfg： ，
6. docs 目录： ，
7. tests 目录：包含项目的测试代码和测试数据，用于验证项目的正确性和稳定性。包括单元测试、集成测试等，帮助开发者确保项目的质量和可靠性。
8. src 或者 lib 目录：包含项目的源代码文件。根据项目的规模和结构，可以进一步组织成子目录或包，方便代码的组织和维护。
除了上述基本文件，根据项目的特点和需求，还可以包含其他文件，如配置文件、示例代码、演示视频等。重要的是根据项目的具体情况进行文件的组织和描述，确保项目的可理解性、可维护性和可扩展性。
```bash
# 将输出重定向到文件：
pip freeze > requirements.txt
# 老师一键安装项目所有依赖， ，
pip install -r requirements.txt
```
