统一的项目规范是团队协作的基础。良好的规范能够降低沟通成本、减少潜在错误、提升代码的可维护性和可读性。
本文从项目结构、命名规则、Java 日志规范三个维度,梳理软件开发中的核心工程规范。
1. 项目结构
以下为项目根目录下的文件和目录的推荐组织结构:
project-root/
├── codes/ # 代码目录
├── configurations/ # 配置目录
├── demos/ # 示例目录
├── docs/ # 文档目录
├── libs/ # 第三方库文件
├── scripts/ # 脚本目录
├── packages/ # 打包文件目录
├── .gitignore # Git 忽略规则
├── .gitattributes # Git 属性规则
├── .editorconfig # 编辑器书写规则
├── README.md # 项目说明文件
└── LICENSE # 开源协议
2019/3/18大约 5 分钟