代码规范问题

代码规范

今天简单讲讲代码规范问题。参考清华大学程序设计Rust训练组课程要求

1 简洁

要保证代码的简洁

1. 有整齐的缩进，建议用空格缩进而不是tab，两个或四个空格为一级缩进（我个人喜欢四个空格）
2. 每一行不能有太多字符
3. 减少硬编码（比如直接指定路径地址，硬编码让用户只能在源代码中进行修改）
4. 减少Magic Number的出现

2 注释

1. 比较复杂的代码块前，描述代码的功能
2. 过于简单的代码，可以不写注释
3. 函数要编写注释，包括__函数的功能、参数、输出__
4. 建议用英文注释，中文注释要使用UTF-8编码
5. 遵循Rustdoc的约定

3 空白

代码中要有适当的空格和空行

1. 函数中实现不同功能的代码间需要添加空行
2. 操作符前后要有空格，C = A + B；
3. 保持前后一致的风格

4 命名

这部分可以参考Java命名规范

5 工具

为了实现上述要求，偷懒的话，可以使用编辑器自带的格式化功能
比如rustfmt或者cargo fmt