软件项目文件夹命名

本文参考——软件项目文件夹命名

---

• src

解释：source的简写，指源代码。

位置：一级目录。

作用：存放源代码。

---

• lib/dep/plugins

解释：library/dependence/plugins的简写，依赖工具库/框架。

位置：二级目录。

作用：存放依赖的第三方工具库/框架（如：jquery）。

---

• bin

解释：binary的简写。

位置：一级目录。

作用：存放二进制文件（如：*.exe）。

---

• dist/build

解释：distribution/build的简写。

位置：一级目录。

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

---

• docs

解释：document的简写。

位置：一级目录。

作用：存放一些需求文档，开发文档。

---

• examples/demo

解释：软件应用的例子。

位置：二级目录。

作用：存放一些实例。

---

• asset

解释：项目资源。

位置：二级目录。

作用：存放一些多媒体资源（如：图片、音视频）。

延伸：

        存放的资源会经过编译处理。

        static/resources/res

        解释：项目资源。

        位置：二级目录。

        作用：存放一些静态资源（如：图片、音视频）。

延伸：

        存放的资源不会经过编译处理。

        images

        解释：图片资源。

        位置：三级目录。

        作用：存放一些图片资源。

---

• media

解释：媒体资源。

位置：三级目录。

作用：存放一些音视频资源。

---

• audio

解释：音频资源。

位置：三级目录。

作用：存放一些音视资源。

---

• video

解释：视频资源。

位置：三级目录。

作用：存放一些视频资源。

---

• utils/tools

解释：项目需要使用到的工具方法代码。

位置：二级目录。

作用：存放一些工具方法代码。

延伸：

        存放项目自定义的工具方法代码，非第三方工具方法代码。

        common/public

        解释：通用资源。

        位置：二级目录。

        作用：存放一些公共资源（如：公共图片、公共音视频、公用工具库）。

---

• locale

解释：区域语言目录，国际化。

位置：二级目录。

作用：存放一些国际化与本地化的配置文件（i18n与l10n）。

延伸：

i18n 和 L10n区别

---

• api

解释：Application Programming Interface的简写，应用程序编程接口。

位置：二级目录。

作用：存放一些应用程序接口的方法代码。

---

• db

解释：database的简写，数据库。

位置：二级目录。

作用：存放一些访问数据库的方法代码。

---

• conf

解释：config的简写，配置文件。

位置：一级目录。

作用：存放一些项目配置文件（如：xml、json）。

---

• logs

解释：日志文件。

位置：一级目录/二级目录。

作用：存放一些日志文件。

---

• test/__test__

解释：单元测试文件。

位置：一级目录/二级目录。

作用：存放一些单元测试文件。

---

• client

解释：客户端源代码。

位置：二级目录。

作用：存放前端源代码。

---

• server

解释：服务端源代码。

位置：二级目录。

作用：存放后端源代码。

延伸：

client/server 目录适合全栈项目，非全栈项目建议分开单独一个项目。

---

建议：

• 顶级文件夹命名一律缩写
• 文件夹命名一律小写
• 文件夹命名一律复数单词
• 文件夹层次不宜过多，最多不超过五层
• 不要在根文件夹中存储任何资源文件，尽可能使用子目录