高质量编程简介及编程规范
从算法题中引出工作的功能实现
高质量编程
1.正确可靠
2.简洁清晰
考虑边界条件,异常情况处理,易读易维护(不必追求短)
1.代码格式 gofmt自动格式化代码
go imports
2.注释
(1).解释代码作用(注释公共符号)
(2).解释代码如何做的
(3).解释代码实现原因
(4).代码什么情况会出错(解释代码限制条件)
3.命名规范
(1).简洁
(2).缩略词全小写
(4).名字本身携带更多上下文意义
(5).不要与标准库同名,(fmt指format)
4.控制流程
(1)避免嵌套
(2)保持正常代码为最小缩进
(3).线性原理
5.错误和异常处理
error
errors.New创建匿名变量表示简单(仅出现一次)错误
格式化用fmt.Errorf
errors.Is判断一个错误是否
为特定错误不同于==
不在业务代码中用panic,error代替panic
recover只能被defer的函数中使用 嵌套无法生效 debug.Stack记录错误信息
defer语句会在返回前调用
defer语句先进后出
高质量代码的好处有许多
-
提高可靠性:
- 高质量代码意味着更少的错误和漏洞,从而提高软件的可靠性。
- 可靠的软件能够减少崩溃和失败的可能性,提升用户体验。
-
增强可维护性:
- 清晰、简洁且结构良好的代码易于理解和修改。
- 良好的代码注释和文档有助于维护者快速了解代码的功能和目的。
- 模块化设计使得代码在需要时可以轻松地进行扩展或重构。
-
提升可扩展性:
- 高质量代码通常具有更好的可扩展性,便于添加新功能或进行性能优化。
- 良好的代码结构使得新功能能够无缝集成到现有系统中。
-
缩短开发周期:
- 清晰的代码可以减少调试和测试的时间。
- 易于维护的代码可以加快修复问题和更新软件的速度。
-
减少成本:
- 高质量代码减少了因错误和缺陷导致的返工成本。
- 长期来看,减少维护成本,因为系统更稳定、易于升级。
-
提高安全性:
- 编写安全的代码可以防止数据泄露、恶意攻击和其他安全问题。
- 遵循最佳实践和安全编码指南可以提高代码的安全性。
-
提升团队协作效率:
- 统一的代码风格和结构有助于团队成员之间的协作。
- 清晰的代码使得代码审查更加高效,有助于及时发现问题。
-
促进技术债务管理:
- 高质量代码减少了技术债务,使系统更易于管理和维护。
- 减少因技术债务累积而导致的开发瓶颈和成本增加。
总而言之,在你在github上扒到的最讨厌的代码,就是你最不该写的代码,有些时候很习惯以1,2,3,4来命名,虽然短,但想找究竟是什么的时候着实费劲,何况是体量巨大的项目,高质量代码,对别人好就是对自己好