项目简介
本项目用于Eプロスロット的程序开发,通过制定文件夹结构、编码规范以及git使用规则,规范开发流程,提升代码质量与可维护性。
项目的主要特性和功能
文件夹结构规范
- 头文件统一存于「headerfiles」文件夹。
- 测试用的Arduino文件(.ino)存于「test_mainfiles」文件夹。
编码规范
- 头文件函数需添加功能说明注释。
- 仅包含必要头文件。
- 采用包含保护机制。
- 遵循特定命名规则(https://e-penguiner.com/naming-conventions-cpp/)。
Git使用规范
- 按功能创建分支。
- 编写合适的提交信息。
安装使用步骤
假设用户已下载本项目的源码文件: 1. 依照项目文件夹结构规范,将头文件放于「headerfiles」文件夹,测试用的Arduino文件放于「test_mainfiles」文件夹。 2. 依据编码规范编写代码,留意头文件注释、包含规则、包含保护和命名规则。 3. 使用git进行版本管理时,按功能创建分支并编写合适的提交信息。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】