refactor: revise code comments

Author: voidint

build/build.go

@@ -27,7 +27,7 @@ import (
 )
 
 const (
-	// ShortVersion 短版本号
+	// ShortVersion short version number
 	ShortVersion = "1.7.0"
 )
 
@@ -41,7 +41,7 @@ var (
 	GitCommit string
 )
 
-// Version 生成版本信息
+// Version returns the version information.
 func Version() string {
 	var buf strings.Builder
 	buf.WriteString(ShortVersion)

cli/cli.go

@@ -24,7 +24,7 @@ var (
 	goroot       string
 )
 
-// Run 运行g命令行
+// Run executes the g command line interface.
 func Run() {
 	app := cli.NewApp()
 	app.Name = "g"
@@ -94,7 +94,7 @@ const (
 	mirrorSep = ","
 )
 
-// ghome 返回g根目录
+// ghome returns the root directory of g installations.
 func ghome() (dir string) {
 	if experimental := os.Getenv(experimentalEnv); strings.EqualFold(experimental, "true") {
 		if dir = os.Getenv(homeEnv); dir != "" {
@@ -105,13 +105,13 @@ func ghome() (dir string) {
 	return filepath.Join(homeDir, ".g")
 }
 
-// inuse 返回当前的go版本号
+// inuse detects currently active Go version.
 func inuse(goroot string) (version string) {
 	p, _ := os.Readlink(goroot)
 	return filepath.Base(p)
 }
 
-// installed 返回当前的已经安装的go版本号
+// installed lists all downloaded Go versions.
 func installed() (versions map[string]bool) {
 	dirs, err := os.ReadDir(versionsDir)
 	if err != nil {
@@ -143,7 +143,7 @@ const (
 	jsonMode = 1
 )
 
-// render 渲染go版本列表
+// render outputs version list in specified format.
 func render(mode uint8, installed map[string]bool, items []*version.Version, out io.Writer) {
 	switch mode {
 	case jsonMode:
@@ -180,7 +180,7 @@ func render(mode uint8, installed map[string]bool, items []*version.Version, out
 	}
 }
 
-// errstring 返回统一格式的错误信息
+// errstring formats error messages with consistent style.
 func errstring(err error) string {
 	if err == nil {
 		return ""

cli/install.go

@@ -42,7 +42,7 @@ func install(ctx *cli.Context) (err error) {
 		return cli.ShowSubcommandHelp(ctx)
 	}
 
-	// 查找版本
+	// Find matching Go version.
 	c, err := collector.NewCollector(strings.Split(os.Getenv(mirrorEnv), mirrorSep)...)
 	if err != nil {
 		return cli.Exit(errstring(err), 1)
@@ -64,12 +64,12 @@ func install(ctx *cli.Context) (err error) {
 	vname = v.Name()
 	targetV := filepath.Join(versionsDir, vname)
 
-	// 检查版本是否已经安装
+	// Check if the version is already installed.
 	if finfo, err := os.Stat(targetV); err == nil && finfo.IsDir() {
 		return cli.Exit(fmt.Sprintf("[g] %q version has been installed.", vname), 1)
 	}
 
-	// 查找版本下当前平台的安装包
+	// Find installation packages for current platform
 	pkgs, err := v.FindPackages(version.ArchiveKind, runtime.GOOS, runtime.GOARCH)
 	if err != nil {
 		return cli.Exit(errstring(err), 1)
@@ -127,7 +127,7 @@ func install(ctx *cli.Context) (err error) {
 	filename := filepath.Join(downloadsDir, fmt.Sprintf("go%s.%s-%s.%s", vname, runtime.GOOS, runtime.GOARCH, ext))
 
 	if _, err = os.Stat(filename); os.IsNotExist(err) {
-		// 本地不存在安装包，从远程下载并检查校验和。
+		// Download package remotely and verify checksum.
 		if _, err = pkg.DownloadWithProgress(filename); err != nil {
 			return cli.Exit(errstring(err), 1)
 		}
@@ -142,7 +142,7 @@ func install(ctx *cli.Context) (err error) {
 
 	} else {
 		if !skipChecksum {
-			// 本地存在安装包，检查校验和。
+			// Verify checksum for local package.
 			fmt.Println("Computing checksum with", pkg.Algorithm)
 			if err = pkg.VerifyChecksum(filename); err != nil {
 				_ = os.Remove(filename)
@@ -152,14 +152,14 @@ func install(ctx *cli.Context) (err error) {
 		}
 	}
 
-	// 删除可能存在的历史垃圾文件
+	// Clean up legacy files.
 	_ = os.RemoveAll(filepath.Join(versionsDir, "go"))
 
-	// 解压安装包
+	// Extract installation archive.
 	if err = archiver.Unarchive(filename, versionsDir); err != nil {
 		return cli.Exit(errstring(err), 1)
 	}
-	// 目录重命名
+	// Rename version directory.
 	if err = os.Rename(filepath.Join(versionsDir, "go"), targetV); err != nil {
 		return cli.Exit(errstring(err), 1)
 	}
@@ -168,7 +168,7 @@ func install(ctx *cli.Context) (err error) {
 		return nil
 	}
 
-	// 重新建立软链接
+	// Recreate symbolic link.
 	_ = os.Remove(goroot)
 
 	if err = mkSymlink(targetV, goroot); err != nil {

collector/internal/go_file_item.go

@@ -142,7 +142,7 @@ func Convert2Versions(items []*GoFileItem) (vers []*version.Version, err error)
 				Size:     pitem.Size,
 			})
 		} else if pitem.isSHA256File() {
-			// 设置校验和及算法
+			// Set checksum and hashing algorithm.
 			for _, ppkg := range pkgMap[ver] {
 				if !strings.HasPrefix(pitem.FileName, ppkg.FileName) {
 					continue

collector/official/official_collector.go

@@ -37,14 +37,14 @@ const (
 	Name = "official"
 )
 
-// Collector 官方站点版本采集器
+// Collector collects Go versions from official download page.
 type Collector struct {
 	url  string
 	pURL *stdurl.URL
 	doc  *goquery.Document
 }
 
-// NewCollector 返回采集器实例
+// NewCollector creates a new collector instance for official Go downloads.
 func NewCollector(downloadPageURL string) (*Collector, error) {
 	if downloadPageURL == "" {
 		return nil, errs.ErrEmptyURL
@@ -108,12 +108,12 @@ func (c *Collector) findPackages(table *goquery.Selection) (pkgs []*version.Pack
 	return pkgs
 }
 
-// hasUnstableVersions 返回是否包含非稳定版本的布尔值
+// hasUnstableVersions checks if unstable versions exist in document.
 func (c *Collector) hasUnstableVersions() bool {
 	return c.doc.Find("#unstable").Length() > 0
 }
 
-// StableVersions Return all stable versions
+// StableVersions retrieves all stable Go versions from official releases.
 func (c *Collector) StableVersions() (items []*version.Version, err error) {
 	var divs *goquery.Selection
 	if c.hasUnstableVersions() {
@@ -147,7 +147,7 @@ func (c *Collector) StableVersions() (items []*version.Version, err error) {
 	return items, nil
 }
 
-// UnstableVersions Return all stable versions
+// UnstableVersions fetches pre-release and development builds of Go.
 func (c *Collector) UnstableVersions() (items []*version.Version, err error) {
 	c.doc.Find("#unstable").NextUntil("#archive").EachWithBreak(func(i int, div *goquery.Selection) bool {
 		vname, ok := div.Attr("id")
@@ -174,7 +174,7 @@ func (c *Collector) UnstableVersions() (items []*version.Version, err error) {
 	return items, nil
 }
 
-// ArchivedVersions Return all archived versions
+// ArchivedVersions provides historical Go versions no longer supported.
 func (c *Collector) ArchivedVersions() (items []*version.Version, err error) {
 	c.doc.Find("#archive").Find("div.toggle").EachWithBreak(func(i int, div *goquery.Selection) bool {
 		vname, ok := div.Attr("id")
@@ -201,7 +201,7 @@ func (c *Collector) ArchivedVersions() (items []*version.Version, err error) {
 	return items, nil
 }
 
-// AllVersions 返回所有已知版本
+// AllVersions returns all known Go versions including stable/unstable/archived.
 func (c *Collector) AllVersions() (items []*version.Version, err error) {
 	items, err = c.StableVersions()
 	if err != nil {

pkg/checksum/checksum.go

@@ -30,17 +30,17 @@ import (
 	"github.com/voidint/g/pkg/errs"
 )
 
-// Algorithm 校验和算法
+// Algorithm checksum algorithm type
 type Algorithm string
 
 const (
-	// SHA256 校验和算法-sha256
+	// SHA256 algorithm using SHA-256 hash function.
 	SHA256 Algorithm = "SHA256"
-	// SHA1 校验和算法-sha1
+	// SHA1 algorithm using SHA-1 hash function.
 	SHA1 Algorithm = "SHA1"
 )
 
-// VerifyFile 检查目标文件校验和
+// VerifyFile validates file integrity against expected checksum.
 func VerifyFile(algo Algorithm, expectedChecksum, filename string) (err error) {
 	f, err := os.Open(filename)
 	if err != nil {