rust-guide命名规范速查:用UpperCamelCase和snake_case写出可审计的安全代码
rust-guide命名规范速查用UpperCamelCase和snake_case写出可审计的安全代码【免费下载链接】rust-guideRecommendations for secure applications development with Rust项目地址: https://gitcode.com/gh_mirrors/ru/rust-guiderust-guide是法国国家网络安全局ANSSI发布的 Rust 安全应用开发指南其中命名规范章节是保障代码可审计性的第一道防线统一的UpperCamelCase和snake_case让读者与审计员一眼就能分清类型、函数和常量从而快速发现被刻意隐藏的unsafe或可疑转换。为什么命名是安全代码的第一道防线对安全软件来说代码不只是给编译器看的更是给人类审计员看的。混乱的命名会带来两个真实风险️误读风险一个看起来像常量的全局变量实际却是可变的static mut审查者可能错过它的并发隐患绕过风险审计unsafe块时统一的命名风格让你能迅速定位谁在做转换、谁在操作指针。指南将遵守命名规范列为**必须MUST**级别的规则理由正是清晰即安全。四大核心命名规则速查表Rust 标准库就是事实上的命名标杆基础规则(C-CASE)只有四条背下来即可命名风格适用对象例子UpperCamelCase类型、trait、枚举变体、泛型类型参数HttpRequest、MyEnum::Variantsnake_case函数、方法、宏、变量、模块parse_header、user_idSCREAMING_SNAKE_CASE静态变量、常量、泛型常量参数MAX_RETRY_COUNT、BUFFER_SIZE小写生命周期a、lifetime尽量用单字母 记忆口诀类型大写驼峰函数变量下划线常量全大写生命周期打引号。高频场景的长尾命名约定基础规则之外Rust API Guidelines 还规定了若干细粒度约定它们是日常写库、做代码审查时最常被问到的部分(C-CONV)转换方法按as_零成本、不消费、to_分配新内存、into_消费自身区分例如as_str、to_string、into_vec(C-GETTER)取值方法优先直接读字段或self方法避免多余的get_前缀(C-ITER)迭代器方法统一用iter、iter_mut、into_iter三件套(C-ITER-TY)迭代器类型类型名与产生它的方法对应iter()产生Iter(C-FEATURE)功能开关cargo feature 命名不含placeholder、new这类占位词(C-WORD-ORDER)词序一致性同一概念在全项目中保持相同词序如都用byte_buffer不要混用buffer_byte。让编译器与 Clippy 替你把关好消息是规范不必靠自觉工具链会强制检查。️编译器内置检查基础规则(C-CASE)由nonstandard_stylelint 组直接检查——命名写错编译时就会收到警告Clippy 风格检查clippy工具的style类 lint 能进一步检查命名一致性例如wrong_self_convention会核对as_/to_/into_前缀与接收者self/self/mut self是否匹配rustfmt 统一格式指南同样建议SHOULD使用rustfmt保证整个代码库风格一致可用项目根目录的rustfmt.toml自定义规则。指南对此有两条硬规则开发期间必须定期运行 linter任何自动修复clippy fix、cargo fix都必须由开发者人工复核后再提交。去哪里看完整规则本项目的规范章节位于 src/en/naming.md中文开发者可对照法语版 src/fr/naming.md关于 Clippy 与 rustfmt 的使用建议见开发环境章节 src/en/devenv.md。项目目录结构如下rust-guide/ ├── src/en/naming.md # 命名规范英文主版本 ├── src/fr/naming.md # 命名规范法语版 ├── src/en/devenv.md # rustfmt / clippy 工具使用建议 └── examples/ # 配套示例代码一分钟自检清单提交前花一分钟过一遍审计效率立刻提升类型与 trait 都是UpperCamelCase吗函数、变量、模块都是snake_case吗常量与static都是SCREAMING_SNAKE_CASE吗as_/to_/into_前缀与接收者匹配吗cargo clippy无风格类警告吗✅ 按 rust-guide 执行这五条检查你的代码不仅更符合 Rust 生态惯例更能让安全审计像顺藤摸瓜一样顺滑——命名规范就是最廉价的安全投资。【免费下载链接】rust-guideRecommendations for secure applications development with Rust项目地址: https://gitcode.com/gh_mirrors/ru/rust-guide创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考