Go 高质量编程| 青训营笔记

36 阅读2分钟

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

前言

今天是Go语言的高质量编程的内容,主要是如何规范标准的去进行开发。也就是优雅的写代码。

首先,需要先把课程给出的几个示例给clone下来。

-克隆网址一到本地,保证能够编译运行

-尝试使用 test 命令,编写并运行简单测试网址二

-常试使用 -bench 参数,对编写的函数进行性能测试网址三

image.png

内容简介

一般来说,高质量的代码具有以下特点:

  • 可读性高

  • 结构清晰

  • 可扩展(方便维护)

  • 代码风格统一

  • 低复杂性

  • 简练

在课程中将这些总结为了:简单性、可读性和生产力。 而实现他们就需要规范编码了,规范编码的好处是显而易见的,非常多。并且不仅有大众共同接受的规范,各个公司似乎也有自己私下的一些规范。这里就以常见的来讲。

  • 代码格式
  • 注释
  • 命名规范
  • 控制流程

这几个应该是比较常见的,更多的可以了解百度编码规范:GitHub - ecomfe/spec: This repository contains the specifications.

高质量编码

注释

首先以注释讲起,应该每个学生都看过不少关于屎山代码的段子,他们应该都离不开注释和命名规范相关的内容,特别是后人接触前人的屎山代码。

因此代码里面注释是非常重要的。以本人拙见,注释应该包括:作者名称,联系方式,创作时间,功能,以及具体每一块的作用,除此之外还需要在恰当的地方用通俗的语言来解释。甚至要加上过去版本的代码片段。

image.png

解释功能

image.png

较复杂部分应充分注释

命名规范

按照规范来命名可以显著降低他人理解代码的难度,并且也可以让代码看起来更美观。 所以一定要简介、英文、全文对照且非拼音等。 比如说

sum := 0;
zongshu := 0 ;
allnum := 0 ;

显而易见后两个是不太合适的,用拼音和冗长的名称,长期不规范的开发则容易形成屎山。

控制流程

这一个part则容易理解的多了,就是尽量不要搞嵌套,for,甚至是多层的for去遍历,这样会容易引起故障,并且复杂度高,算法里面一般会尽量避免如此。

image.png

引用

令人头疼的代码命名规范…… - 腾讯云开发者社区-腾讯云 (tencent.com)

代码命名规范指引 - 掘金 (juejin.cn)