C++文件结构

代码规范二、文件结构

良好的文件结构往往一目了然,在其架构时就应该确定基本的文件结构,为后续开发打下基础。

在此中良好的文件夹命名,有利于软件项目的维护和迭代。

建议

所有的文件夹应当使用小写

文件夹命名应当使用复数单词

文件夹层数原则上不应该超过5层

不能在根目录下存放任何资源文件,应当使用专门设置资源子目录


(一)、一级目录

1、src

解释

source 简写,指代源代码

作用

存放源文件

2、bin

解释

binary的简写,指代二进制文件(一般为可执行文件)

作用

存放二进制文件,例如:.exe

3、docs

解释

document的简写,指代文档文件

作用

存放一些需求文档、开发文档

4、conf

解释

config的简写,指代配置文件

作用

存放一些项目配置文件,例如:.xml、.json

5、logs

解释

指代日志文件

作用

存放一些日志文件

6、locale

解释

local译为地方的、本地的,指代软件区域语言国际化

作用

存放一些国际化或本地化配置文件,例如:i18n与l10n

7、asset

解释

asset 译为资产,指代项目资源

作用

存放一些多媒体资源,例如:图片、音频、视频等

8、lib

解释

lib译为库文件,指代静态库

作用

用于存放静态库、同时也用于存放头文件

9、include

解释

include译为包含、包括,指代头文件

作用

用于存放头文件

(二)、二级目录

1、dist/build

解释

distribution/build的简写,指代构建完成的文件

作用

存放最终发布的代码或应用

2、examples/demo

解释

指代示例文件

作用

存放一些软件应用的示例代码,或存放软件示例应用

3、utils/tools

解释

utils可译为使用程序,tool译为工具,指代工具方法代码文件

作用

存放一些工具方法代码文件

4、src/test

解释

test译为测试,指代测试文件

作用

用于存放一些单元测试文件

5、src/client

解释

client,客户端

作用

用于存放客户端/前端代码文件

6、src/server

解释

server,服务端

作用

用于存放服务端/后端代码文件

7、src/api

解释

Application Programming Interface 缩写,译为应用程序编程接口

作用

用于存放一些接口方法代码

8、src/db

解释

database 缩写,译为数据库

作用

存放一些访问数据库代码文件

9、asset/images

解释

图片资源

作用

存放一些图片资源

10、asset/video

解释

视频资源

作用

存放一些视频资源

11、asset/audio

解释

音频资源

作用

存放一些音频资源


参考:
C/C++代码规范(一)——文件结构、排版、命名规则
了解一些常见的软件项目文件夹命名

posted @ 2023-04-15 12:35  木木亚伦  阅读(131)  评论(0编辑  收藏  举报