Rust-bitcoin项目中的文件名命名规范探讨

在Rust-bitcoin项目中，关于Rust源代码文件命名时使用下划线(_)还是连字符(-)的问题引发了开发团队的讨论。这个问题看似简单，但实际上涉及到代码一致性、工具链兼容性以及开发者体验等多个方面。

背景

Rust社区普遍倾向于在文件名中使用下划线(_)，这是由Rust工具链的特性决定的。然而在rust-bitcoin项目中，examples目录下存在使用连字符(-)命名的文件，如sign-tx-segwit-v0.rs，这与项目其他部分的命名风格不一致。

技术考量

1. 工具链兼容性：Rust工具链对下划线的支持更好，这是社区普遍采用下划线的主要原因。虽然连字符在视觉上可能更清晰易读，但工具链处理时可能会遇到问题。

2. 开发者体验：当使用cargo run --example命令时，需要输入与文件名完全一致的名称。如果文件名使用下划线，而特性(features)使用连字符，会导致开发者需要记住两种不同的命名风格。

3. 历史兼容性：有人担心修改文件名会破坏已有的外部链接，但团队成员认为不应该为此牺牲代码一致性，特别是那些没有使用永久链接的临时链接。

项目决策

经过讨论，rust-bitcoin项目决定采用以下命名规范：

• 项目中的Rust源代码文件统一使用下划线(_)命名
• 唯一的例外是examples目录下的文件，允许使用连字符(-)

这一折中方案既保持了与Rust工具链的最佳兼容性，又在一定程度上简化了示例代码的使用体验。开发者只需在创建示例文件时注意使用连字符，而在其他所有地方都使用下划线。

最佳实践建议

对于类似的开源Rust项目，建议：

1. 优先遵循Rust社区的普遍惯例，使用下划线命名文件
2. 如果确实需要使用连字符，应限制在特定目录(如examples)中
3. 在项目文档中明确记录命名规范，方便贡献者遵循
4. 不要因为担心破坏临时链接而牺牲代码一致性

这个讨论展示了即使是简单的命名问题，也需要权衡技术限制、开发者体验和项目一致性等多个因素。rust-bitcoin项目通过这种细致的讨论和明确的决策，保持了代码库的高质量和一致性。