Golang语言开发注意事项

简介: 这篇文章总结了Go语言开发中的注意事项,包括语法细节、注释使用、代码风格、API文档的利用以及如何使用godoc工具来生成文档。

作者:尹正杰
版权声明:原创作品,谢绝转载!否则将追究法律责任。

一.Go语法注意事项

- Golang源代码文件以".go"为扩展名;

- Golang程序的执行入口是"main()"函数;

- Golang严格区分字母大小写;

- 方法由一条条语句构成,每个语句后不需要分号(Go语言会在每行后自动加分号),这也体现出Golang的简洁性。

- Go编辑器是一行行进行编译的,因此我们一行就写一条语句,不要把多个语句写在同一行,否则报错;

- 定义变量或者import的包如何没有使用到,代码不能编译通过。

- 大括号都是成对出现的,缺一不可。

二.Go语法注释

注释的作用:
    用于注解说明程序的文字就是注释,注释提高了代码的阅读性,注释是一个程序必须要具有的良好编程习惯。
    注释可以将自己的思想通过注释先成立出现,再用代码去实现。

Golang中注释类型:
    Go语言支持C语言风格的块注释,也支持c++风格的行注释。
        行注释:
            使用"//",对应VSCode快捷键: "ctrl + /"。
        块注释:
            也称为多行注释,使用"/**/",对应VSCode快捷键: "shift + alt + a"。

温馨提示:
    1.块注释中不可以嵌套块注释。
    2.相比于块注释,行注释更通用,块注释主要用于针对包的详细说明或者屏蔽大块的代码。

三.代码风格

- 注意缩进;

- 成对编程,如使用"",'',{},()等;

- 运算符两边加空白;

- 代码注释(官方Go语言源码大量使用"行注释");

- 一行代码最长不超过80个字符,超过请使用换行展示,尽量保持格式优雅;

温馨提示:
    可以使用"gofmt -w xxx.go"

四.应用编程接口API

应用程序接口(Application Programming Interface,简称"API"):
    是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。
    目的是提供应用程序与开发人员基于某软件或硬件得以访问一部分代码的能力,而又无需访问源码,或理解内部工作机制的细节。

Go语言提供了大量标准库,因此google公司也为这些标准库提供了相应的API文档,用于高速开发者如何使用这些标准库,以及标准库包含的方法。

官方网址:(需"FQ")
    https://golang.org

Golang中文网在线标准库文档:
    https://studygolang.com/pkgdoc

五.Go注释与godoc详解

推荐阅读:
    https://developer.aliyun.com/article/1604746
目录
相关文章
|
14天前
|
Go
Golang语言之管道channel快速入门篇
这篇文章是关于Go语言中管道(channel)的快速入门教程,涵盖了管道的基本使用、有缓冲和无缓冲管道的区别、管道的关闭、遍历、协程和管道的协同工作、单向通道的使用以及select多路复用的详细案例和解释。
47 4
Golang语言之管道channel快速入门篇
|
14天前
|
Go
Golang语言文件操作快速入门篇
这篇文章是关于Go语言文件操作快速入门的教程,涵盖了文件的读取、写入、复制操作以及使用标准库中的ioutil、bufio、os等包进行文件操作的详细案例。
37 4
Golang语言文件操作快速入门篇
|
14天前
|
Go
Golang语言之gRPC程序设计示例
这篇文章是关于Golang语言使用gRPC进行程序设计的详细教程,涵盖了RPC协议的介绍、gRPC环境的搭建、Protocol Buffers的使用、gRPC服务的编写和通信示例。
42 3
Golang语言之gRPC程序设计示例
|
14天前
|
安全 Go
Golang语言goroutine协程并发安全及锁机制
这篇文章是关于Go语言中多协程操作同一数据问题、互斥锁Mutex和读写互斥锁RWMutex的详细介绍及使用案例,涵盖了如何使用这些同步原语来解决并发访问共享资源时的数据安全问题。
37 4
|
14天前
|
Go
Golang语言错误处理机制
这篇文章是关于Golang语言错误处理机制的教程,介绍了使用defer结合recover捕获错误、基于errors.New自定义错误以及使用panic抛出自定义错误的方法。
36 3
|
14天前
|
Go 调度
Golang语言goroutine协程篇
这篇文章是关于Go语言goroutine协程的详细教程,涵盖了并发编程的常见术语、goroutine的创建和调度、使用sync.WaitGroup控制协程退出以及如何通过GOMAXPROCS设置程序并发时占用的CPU逻辑核心数。
23 4
Golang语言goroutine协程篇
|
14天前
|
Prometheus Cloud Native Go
Golang语言之Prometheus的日志模块使用案例
这篇文章是关于如何在Golang语言项目中使用Prometheus的日志模块的案例,包括源代码编写、编译和测试步骤。
20 3
Golang语言之Prometheus的日志模块使用案例
|
14天前
|
Go
Golang语言之函数(func)进阶篇
这篇文章是关于Golang语言中函数高级用法的教程,涵盖了初始化函数、匿名函数、闭包函数、高阶函数、defer关键字以及系统函数的使用和案例。
16 3
Golang语言之函数(func)进阶篇
|
14天前
|
Go
Golang语言之函数(func)基础篇
这篇文章深入讲解了Golang语言中函数的定义和使用,包括函数的引入原因、使用细节、定义语法,并通过多个案例展示了如何定义不返回任何参数、返回一个或多个参数、返回值命名、可变参数的函数,同时探讨了函数默认值传递、指针传递、函数作为变量和参数、自定义数据类型以及返回值为切片类型的函数。
17 2
Golang语言之函数(func)基础篇
|
14天前
|
Go
Golang语言之映射(map)快速入门篇
这篇文章是关于Go语言中映射(map)的快速入门教程,涵盖了map的定义、创建方式、基本操作如增删改查、遍历、嵌套map的使用以及相关练习题。
21 5