首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >Rust项目的推荐目录结构是什么?

Rust项目的推荐目录结构是什么?
EN

Stack Overflow用户
提问于 2016-07-09 08:03:51
回答 1查看 9.5K关注 0票数 26

应该将源代码、示例、文档、单元测试、集成测试、许可证、基准测试等放在哪里

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2016-07-09 09:07:02

Cargo,Rust的官方包管理器,defines some conventions regarding the layout of a Rust crate

。Cargo.lock Cargo.toml simple.rs├──│└──lib.rs main.rs├──│└──├──│└──lib.rs-│├──-││└──│├──│└──│├──││└──│├──│└──│└──├──-│└──-├──-│├──.rs├──│└──├──│└──lib.rs│├──src││└──bin│├──│└──└──│├──││└──│├──│└──-├──-│├──s.rs

  • Cargo.toml和测试存储在project.
  • Source代码的根目录中directory.
  • The默认库文件是src/lib.rs.
  • The默认可执行文件是src/main.rs.
  • Other可执行文件可以放在src/bin/*.rs.
  • Integration测试中放在tests目录中(单元测试放在每个文件中它们是examples directory.
  • Benchmarks中的Cargo.lock可执行文件进入benches目录。

这些在manifest description中有更详细的解释。

通过遵循这个标准布局,您将能够使用Cargo的命令轻松地构建、运行和测试您的项目。运行cargo new以设置新的可执行项目,或运行cargo new --lib以设置新的库项目。

此外,库的文档通常写在文档注释中(在任何项目之前以///开头的注释,或以//!开头的注释,用于记录父项目)。此外,许可证通常放在根目录下。

如上所述,单元测试是在与它们测试的函数相同的模块中编写的。通常,它们被放在一个内部模块中。它看起来像这样(这是Cargo使用cargo new --lib为新库生成的代码):

代码语言:javascript
复制
#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
    }
}
票数 42
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/38276960

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档