Apakah peranan ulasan dalam bahasa Go

Peranan komen dalam atur cara adalah untuk memberi anotasi dan menerangkan program Ia meningkatkan kebolehbacaan kod program dan memudahkan pembacaan kod sumber itu adalah untuk memudahkan orang lain dan anda sendiri memahami , dan anda boleh mengetahuinya sepintas lalu Apakah fungsi kod ini? Komen Go dibahagikan kepada komen baris "//" dan komen blok "/* */" dalam penggunaan sebenar, komen baris digunakan lebih kerap, dan komen blok digunakan terutamanya untuk memformat penggunaan kod atau pakej yang besar.

Persekitaran pengendalian tutorial ini: sistem Windows 7, GO versi 1.18, komputer Dell G3.

Apakah fungsi ulasan

Komen ialah penjelasan dan perihalan kod, dan tujuannya adalah untuk memudahkan orang ramai? untuk memahami kod tersebut. Komen ialah apabila pengaturcara menulis penjelasan atau pembayang untuk pernyataan, segmen program, fungsi, dsb., yang boleh meningkatkan kebolehbacaan kod program.

Peranan komen dalam program ini adalah untuk memberi anotasi dan menerangkan program untuk memudahkan pembacaan kod sumber. Sistem kompilasi secara automatik akan mengabaikan bahagian yang dikomen semasa menyusun kod sumber, jadi komen tidak akan memainkan sebarang peranan dalam merealisasikan fungsi program. Menambah komen pada kod sumber dengan sewajarnya boleh meningkatkan kebolehbacaan kod sumber.

Komen ialah penerangan dan perihalan kod. Tujuannya adalah untuk memudahkan orang lain dan diri sendiri memahami, dan anda boleh mengetahui kegunaan kod ini sepintas lalu. Komen program yang betul biasanya termasuk ulasan mukadimah dan ulasan berfungsi. Kandungan utama ulasan mukadimah termasuk antara muka modul, penerangan data dan fungsi modul. Kandungan utama ulasan fungsi modul termasuk fungsi segmen program, fungsi pernyataan dan status data.

Klasifikasi ulasan go

Komen Go dibahagikan kepada ulasan baris // dan komen sekat /* */. Dalam penggunaan sebenar, komen baris digunakan lebih kerap dan komen sekat digunakan terutamanya untuk memformat bahagian besar kod atau komen pakej.

Kunci pintasan untuk ulasan baris dalam goland ialah Ctrl+/ dan kekunci pintasan untuk ulasan sekat ialah Ctrl+Shift+/

Gunakan

Fail Komen

Tambahkan ulasan sebelum setiap fail untuk menerangkan pengarang, masa dan hak cipta.

Kita boleh buka pakej untuk semak sesuka hati Contohnya, dalam pakej 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.

ada masa 2011, author go, dan copyright. , kami boleh membukanya sesuka hati Untuk fail lain, anda boleh mendapati bahawa hanya masa berubah, tetapi tiada apa-apa lagi yang berubah.

Di goland, anda boleh mencari dan mengubah suai templat ulasan fail dalam Settings/Editor/File and Code Templates/Files/Go File, supaya ulasan akan dijana secara automatik setiap kali anda membuat fail baharu.

Ini templat saya

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

Komen pakej

Komen pakej digunakan untuk menerangkan dan memperkenalkan pakej ini, dan Berikan beberapa maklumat tentang pakej.

In go, hanya terdapat satu pakej dalam direktori (tidak termasuk subdirektori), jadi boleh terdapat berbilang fail dalam pakej Secara umumnya, tulis sahaja ulasan pakej pada salah satu fail.

Begitu juga, mari kita lihat fail builtin.go dalam pakej terbina

/*
    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.
*/

Anda boleh melihat bahawa fungsi pakej terbina adalah untuk menyediakan pengecam yang dipratentukan dokumen.

Kami juga melihat fail errors.go dalam pakej errors Kami dapat melihat bahawa ulasan pakej adalah sangat panjang

// Package errors implements functions to manipulate errors.

Di sini kita bercakap tentang. ralat pakej yang melaksanakan beberapa pemprosesan fungsi Salah.

// 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.

Terdapat banyak perkara di belakangnya, yang membincangkan tentang fail, prinsip, aplikasi dan maklumat lain yang berkaitan dengan pakej ralat.

Jika kita terus melihat kod sumber, kita akan mendapati bahawa ulasan pakej semuanya bermula dengan package + 一个动词 Secara amnya, ayat pendek ini menerangkan fungsi pakej, dan kemudian menerangkan maklumat lain tentang bergantung pada pakej pada pakej tertentu.

Komen fungsi

Komen fungsi digunakan untuk menerangkan fungsi fungsi dan maklumat lain yang berkaitan.

Mari kita lihat juga fail errors.go dalam pakej errros

// 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视频教程、编程教学】

Atas ialah kandungan terperinci Apakah peranan ulasan dalam bahasa Go. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!