高质量编程 | 青训营笔记

53 阅读2分钟

这是我参与「第五届青训营 」笔记创作活动的第2天

一、本堂课重点内容

作为一个后端程序员,我们的工作主要有业务需求的开发,最主要的工作就是业务代码的编写。而一个大型项目的开发往往是一个团队合作,这就意味着我们编写的代码必须是符合规范的。工作中我们不但要阅读自己的代码,还要去阅读和review别人的代码,拥有一个良好的代码编写习惯既有助于功能的实现,更能快速的理解他人编写的代码,让程序拥有良好的可读性和可维护性。

在前两天的课程中我们已经学习了Go语言的基础,并编写了简单的Go程序,我们的目标就是编写出更简洁清晰的代码。

二、详细知识点介绍

高质量————编写的代码能够达到正确可靠,简洁清晰的目标。

而写出高质量的Go代码我们要注意的有代码格式,注释,命名规范,控制流程,错误和异常处理。

三、实践练习例子

在下面这个例子中,就很好地表现了注释的重要性。注释是用来解释代码的,这段代码中解释了定义的结构的作用和函数的功能。可以让他人更加快速地理解代码地作用。不仅如此,我们还可以在函数内部编写注释来说明代码是如何工作的,并在注释中给出上下文说明。

package main

import (
	"fmt"
)

// Animal has a Name and an Age to represent an animal.
type Animal struct {
	Name string
	Age  uint
}

// String makes Animal satisfy the Stringer interface.
func (a Animal) String() string {
	return fmt.Sprintf("%v (%d)", a.Name, a.Age)
}

func main() {
	a := Animal{
		Name: "Gopher",
		Age:  2,
	}
	fmt.Println(a)
}

同时编码还要注意命名规范。 1.简介胜于冗长。 2.缩略词全大写,例如HTTP,而不是Http。URL而不是Url。 3.变量距离其使用的地方越远,则需要携带越多的上下文信息。 例如在for循环中使用i而不是index。因为i更加简单,index并没有提供额外的信息。

四、课后个人总结

“It's harder to read code than to write it” ———— Joel Spolsky

代码虽然是让机器执行,但要靠人来维护。所以编写简单易读的代码是我们的目标。如果代码难以阅读,后期维护或者更改的人员会面临巨大的挑战,甚至你自己都不知道要如何维护自己的代码。

五、引用参考

fmt package - fmt - Go Packages

掘金课程