Go語言中註釋有什麼作用

註解在程式中的作用是對程式進行註解和說明，高程式碼的可讀性，便於對原始碼的閱讀；目的是為了讓別人和自己很容易看懂，一看就知道這段程式碼是做什麼用的。 go的註解有行註解「//」和區塊註解「/* */」之分；在實際的使用中，行註解使用得比較多，區塊註解主要用於格式化大段程式碼或套件的註解中使用。

本教學操作環境：windows7系統、GO 1.18版本、Dell G3電腦。

註解有什麼作用

註解就是對程式碼的解釋和說明，其目的是讓人們能夠更輕鬆地了解程式碼。註解是編寫程式時，寫程式的人給一個語句、程式段、函數等的解釋或提示，能提高程式碼的可讀性。

註解在程式中的作用是對程式進行註解和說明，以便於對原始碼的閱讀。編譯系統在對原始程式碼進行編譯時會自動忽略註解的部分，因此註解對於程式的功能實作不起任何作用。在源碼中適當地添加註釋，能夠提高源碼的可讀性。

註解就是對程式碼的解釋和說明。目的是為了讓別人和自己很容易看懂，一看就知道這段程式碼是做什麼用的。正確的程序註釋一般包括序言性註釋和功能性註釋。序言性註釋的主要內容包括模組的介面、資料的描述和模組的功能。模組的功能性註釋的主要內容包括程式段的功能、語句的功能和資料的狀態。

go 註解的分類

go 的註解有行註解 // 與區塊註解 /* */ 之分。在實際的使用中，行註解使用得比較多，區塊註解主要用於格式化大段程式碼或套件的註解中使用。

在goland 行註解的快速鍵為 Ctrl /, 區塊註解的快速鍵為 Ctrl Shift /

##應用

文件註釋

在每個文件中前都加上一段註釋，這段註釋用來描述作者，時間，以及版權。

我們可以隨便打開一個包查看，如builtin.go 包中

// Copyright 2011 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

就有時間2011, 作者go，和版權，我們可以隨便打開其他文件，可以發現只有時間在變，其他都沒有改變。

在 goland 中可以在 Settings/Editor/File and Code Templates/Files/Go File 中尋改檔案註解模板，這樣每次新建檔案都會自動產生註解。

這是我的模板

//@program: ${PROJECT_NAME}
//@author: edte
//@create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
package ${GO_PACKAGE_NAME}

套件註解

套件註解用來描述介紹這個套件，以及提供套件的一些資訊。

在 go 中，一個 目錄中只有一個包（不包擴子目錄），所以一個包中可以有多個文件，一般在其中一個文件寫上包註釋即可。

同樣的，我們來看 builtin 這個套件 中的 builtin.go 檔案

/*
    Package builtin provides documentation for Go's predeclared identifiers.
    The items documented here are not actually in package builtin
    but their descriptions here allow godoc to present documentation
    for the language's special identifiers.
*/

可以看到 builtin 套件的作用是給預定義標識符提供文件。

我們同樣來看errors 套件中的errors.go 文件，可以看到套件註解很長

// Package errors implements functions to manipulate errors.

這裡講了套件errors 實作了一些處理錯誤的功能。

// The New function creates errors whose only content is a text message.
//
// The Unwrap, Is and As functions work on errors that may wrap other errors.

後面還有一大堆，講了 errors 套件相關的文件，原理，應用等資訊。

如果我們繼續看原始碼，會發現套件註解都是以package 一個動詞 開頭的，一般這個短句就說明了這個套件的功能，然後再視具體的套件說明包的其他資訊。

函數註解

函數註解用來描述函數的功能，以及其他相關的資訊。

我們同樣來看 errros 套件中的 errors.go 檔案

// New returns an error that formats as the given text.
// Each call to New returns a distinct error value even if the text is identical.
func New(text string) error {
    return &errorString{text}
}

这里用一句话说明了 New 功能的作用，即返回一个自定义的错误。

然后又用一句话说了这个函数相关的特点，即使文本相同，每次对 New 的调用也会返回一个不同的错误值。

如果同样查看其他源码中的函数，我们发现一般几乎都是 函数名 + 一个动词 的句子开头。这个句子同样说明了这个函数的作用，即函数干了些什么。

而其他需要讲解的信息则以复杂度为基础，如果感觉某个点不容易理解，那么最好都要写注释，如函数签名，函数原理，函数使用过程中需要注意的点等。

数据类型注释

数据类型注释说明 这个数据类型用来干什么。

如 errors.go 中

// errorString is a trivial implementation of error.
type errorString struct {
    s string
}

这里就说明了  errorString 的作用，即 error 的具体实现。

如 built.go 中

// bool is the set of boolean values, true and false.
type bool bool

// true and false are the two untyped boolean values.
const (
    true  = 0 == 0 // Untyped bool.
    false = 0 != 0 // Untyped bool.
)

// The error built-in interface type is the conventional interface for
// representing an error condition, with the nil value representing no error.
type error interface {
    Error() string
}

几乎都是以 类型名 + is 开头的句子，这个句子说明了这个类型的作用。

TODO

TODO 即 to do, 是一个特殊的注释，表明在此处有功能等待编写，

FIXME

FIXME 即 fix me, 也是一个特殊的注释，表明此处的功能需要修正，甚至不能运行

XXX

XXX 也是一个特殊的注释，表明此处的功能实现方法有点问题，需要更改

godoc

godoc 是一个实用的工具，可以根据特定的注释格式生成文档。也可以用来查看文档，同样的 go doc 命令也是相似的作用，具体的可以查看这篇文章。

【相关推荐：Go视频教程、编程教学】

以上是Go語言中註釋有什麼作用的詳細內容。更多資訊請關注PHP中文網其他相關文章！