笔记

13 阅读2分钟

高质量代码是能够做到正确可靠,简洁清晰的代码。要写出这种高质量的代码,要遵循简单性,可读性,生产力这几个原则。由于在做一个项目的时候,同常是由一个团队共同完成的,因而与别人合作也是必不可少的,这时,代码的可读性就变得尤为重要。为了防止我们写的代码难以被合作的人理解,包中的常量,变量,函数以及结构都要用简洁易懂的语言来进行注释。

除了注释以外 在编写高质量代码时,也要注意从代码格式,命名规范,控制流程和错误常处理出发。

统一代码格式,能让团队合作的人更多的将注意力放在代码的运行逻辑上。运用gofmt进行自动格式化代码,能更好的将代码统一成官方统一风格,更有利于提高代码的可读性。 在命名规范上,要注意简洁性和大小写,值得注意的是,缩略词位于变量开头且不导出时,使用全小写。当然,也要注意命名时要使名称包含尽量多的信息,使用缩写也要谨慎,尽量使用单数。

控制流程则要求我们编写的时候要避免将运行逻辑复杂化,处理逻辑要尽量走直线,遵从正常的流程代码从上往下写,主要要尽量提高代码的可读性和维护性,避免用复杂的代码从而出错 最后,便是错误的处理。错误的处理又分为简单错误和复杂错误。。对于简单错误,可以用errors.New来创建匿名变量来直接表示错误,想要格式化则直接使用fmt.Error。而复杂错误则可以通过在fmt.Error中使用%w来将错误关联至错误链中。

判断错误,则多用errors.As的方法。

panic使用要谨慎,panic出现表示程序不可再用。