Go言語におけるコメントの役割とは何ですか

プログラム内のコメントの役割は、プログラムに注釈を付けて説明し、プログラムコードの可読性を向上させ、ソースコードを読みやすくすることであり、その目的は、他の人や自分自身が理解しやすくすることです。と、このコードが何をするのか一目でわかります。 Go のコメントは行コメント「//」とブロックコメント「/* */」に分かれており、実際の使用では行コメントの方が多く使用され、ブロックコメントは主にコードやパッケージのコメントの大部分を整形するために使用されます。

このチュートリアルの動作環境: Windows 7 システム、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 では、ディレクトリ (サブディレクトリを除く) にパッケージは 1 つしかないため、パッケージ内に複数のファイルが存在する可能性がありますが、通常はいずれかのファイルにパッケージ コメントを記述するだけです。

同様に、組み込みパッケージ内の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.
*/

組み込みパッケージの機能は、事前定義された識別子のドキュメントを提供することであることがわかります。 。

エラー パッケージ内のerrors.goファイルも確認します。パッケージのコメントが非常に長いことがわかります。

// Package errors implements functions to manipulate 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.

この後、ファイル、原則、アプリケーション、およびエラー パッケージに関連するその他の情報について説明します。

ソース コードをさらに見てみると、パッケージのコメントはすべて 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 中国語 Web サイトの他の関連記事を参照してください。