应该将源代码、示例、文档、单元测试、集成测试、许可证、基准测试等放在哪里
发布于 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.src/lib.rs
.src/main.rs
.src/bin/*.rs
.tests
目录中(单元测试放在每个文件中它们是examples
directory.Cargo.lock
可执行文件进入benches
目录。这些在manifest description中有更详细的解释。
通过遵循这个标准布局,您将能够使用Cargo的命令轻松地构建、运行和测试您的项目。运行cargo new
以设置新的可执行项目,或运行cargo new --lib
以设置新的库项目。
此外,库的文档通常写在文档注释中(在任何项目之前以///
开头的注释,或以//!
开头的注释,用于记录父项目)。此外,许可证通常放在根目录下。
如上所述,单元测试是在与它们测试的函数相同的模块中编写的。通常,它们被放在一个内部模块中。它看起来像这样(这是Cargo使用cargo new --lib
为新库生成的代码):
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
}
}
https://stackoverflow.com/questions/38276960
复制相似问题