代码规范
今天简单讲讲代码规范问题。参考清华大学程序设计Rust训练组课程要求
1 简洁
要保证代码的简洁
- 有整齐的缩进,建议用空格缩进而不是tab,两个或四个空格为一级缩进(我个人喜欢四个空格)
- 每一行不能有太多字符
- 减少硬编码(比如直接指定路径地址,硬编码让用户只能在源代码中进行修改)
- 减少Magic Number的出现
2 注释
- 比较复杂的代码块前,描述代码的功能
- 过于简单的代码,可以不写注释
- 函数要编写注释,包括__函数的功能、参数、输出__
- 建议用英文注释,中文注释要使用
UTF-8
编码 - 遵循Rustdoc的约定
3 空白
代码中要有适当的空格和空行
- 函数中实现不同功能的代码间需要添加空行
- 操作符前后要有空格,
C = A + B;
- 保持前后一致的风格
4 命名
这部分可以参考Java命名规范
5 工具
为了实现上述要求,偷懒的话,可以使用编辑器自带的格式化功能
比如rustfmt
或者cargo fmt
原文地址:http://www.cnblogs.com/jye159X/p/16883870.html
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,请务用于商业用途!
3. 如果你也有好源码或者教程,可以到用户中心发布,分享有积分奖励和额外收入!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是赞助,收取费用仅维持本站的日常运营所需!
7. 如遇到加密压缩包,默认解压密码为"gltf",如遇到无法解压的请联系管理员!
8. 因为资源和程序源码均为可复制品,所以不支持任何理由的退款兑现,请斟酌后支付下载
声明:如果标题没有注明"已测试"或者"测试可用"等字样的资源源码均未经过站长测试.特别注意没有标注的源码不保证任何可用性