文件夹命名该用中横线还是下划线？

Question

在团队协作开发中，文件夹命名常出现使用中横线（kebab-case）还是下划线（snake_case）的争议。例如，项目目录应命名为 `user-profile` 还是 `user_profile`？两者在不同操作系统和工具链中的兼容性如何？特别是在命令行操作、脚本引用或Web服务路径解析时，是否存在潜在问题？哪种命名约定更符合现代前端或后端工程规范？需结合可读性、输入便捷性和跨平台兼容性综合考量。

Answer 1

1. 命名约定的起源与基本概念

在软件工程中，命名规范（Naming Convention）是代码和资源组织的基础。常见的命名方式包括：

• kebab-case：使用连字符分隔单词，如 user-profile
• snake_case：使用下划线分隔单词，如 user_profile
• PascalCase：首字母大写，如 UserProfile
• camelCase：首字母小写，后续单词首字母大写，如 userProfile

其中，kebab-case 和 snake_case 在文件夹命名中尤为常见。它们最初源于不同语言和平台的设计哲学：kebab-case 受到URL友好性的推动，而 snake_case 则源自C语言及其衍生语言的传统。

2. 跨操作系统兼容性分析

操作系统	kebab-case 支持	snake_case 支持	备注
Linux	✅ 完全支持	✅ 完全支持	两者均无问题
macOS	✅ 完全支持	✅ 完全支持	HFS+/APFS均兼容
Windows	✅ 支持	✅ 支持	NTFS无限制
Docker/容器环境	✅ 推荐	⚠️ 潜在问题	部分镜像脚本对下划线敏感

从表中可见，主流操作系统对两种命名方式均无本质限制。但在容器化部署或CI/CD流程中，kebab-case 更受青睐，因其与Docker Hub、Kubernetes等生态工具链高度一致。

3. 命令行与脚本中的实际表现

在Shell脚本或自动化任务中，命名方式会影响命令书写：

# kebab-case 需要引号或转义？
cd user-profile && npm run build

# snake_case 可直接使用
cd user_profile && python app.py

尽管现代Shell（如bash/zsh）能正确解析含连字符的路径，但在变量赋值时易引发歧义：

path=user-profile  # 错误：被解释为减法运算
path="user-profile"  # 正确

相比之下，snake_case 可无缝用于变量名，减少引号依赖，提升脚本可读性。

4. Web服务路径与前端工程规范

在Web开发中，URL语义化至关重要。W3C推荐使用 kebab-case 作为URL路径标准：

https://example.com/api/user-profile
https://example.com/images/user_avatar.png  # 不推荐

现代前端框架（React、Vue、Next.js）普遍采用 kebab-case 组织项目结构：

• components/user-profile/
• pages/settings-account/

这不仅符合RESTful API设计原则，也利于SEO优化——搜索引擎更倾向于将连字符识别为单词分隔符，而非下划线。

5. 工程规范与团队协作建议

graph TD A[选择命名规范] --> B{项目类型} B -->|前端/Web项目| C[推荐 kebab-case] B -->|后端/Python项目| D[推荐 snake_case] B -->|基础设施/脚本目录| E[考虑 snake_case] C --> F[优势：URL友好、SEO佳、现代框架惯例] D --> G[优势：Python模块兼容、Shell脚本简洁] E --> H[避免连字符导致的引用复杂度]

团队应基于技术栈制定统一规范。例如：

• Node.js + React 项目：全系采用 kebab-case
• Django 或 Flask 项目：遵循Python PEP8，使用 snake_case
• 混合架构系统：通过 Linter（如 ESLint、Prettier）强制校验文件名模式