찾다

집 >백엔드 개발 >Golang >盘一盘 Go 语言中的编码规范

盘一盘 Go 语言中的编码规范

Go语言进阶学习
Go语言进阶学习앞으로
2023-07-24 17:45:241191검색

각 언어에는 고유한 코딩 표준이 있습니다. 해당 언어의 명명 표준을 배우면 작성하는 코드를 더 쉽게 읽을 수 있고 낮은 수준의 오류가 발생할 가능성이 줄어듭니다.

개인의 코딩 습관과 인터넷의 일부 기사를 바탕으로 이 기사는 모든 사람이 사용할 수 있는 몇 가지 코딩 표준을 정리했습니다. 이는 일부 주류 솔루션일 수 있지만 공식적인 솔루션을 대표하지는 않습니다.

1. 파일 이름 지정

  1. Windows 플랫폼 파일 이름은 대소문자를 구분하지 않으므로 파일 이름은 항상 소문자를 사용해야 합니다.

  2. 다른 단어 사이에는 밑줄을 사용하고 낙타식 이름 지정은 사용하지 마세요

  3. 테스트 파일이라면 _test.go는 _test.go 结尾

  4. 文件若具有平台特性，应以 文件名_平台.go

    🎜🎜로 끝납니다. 파일에 플랫폼 특성이 있는 경우 파일 이름_platform.go 이름 지정(예: utils_ windows.go, utils_linux.go, 사용 가능한 플랫폼: windows, unix, posix, plan9) , 다윈, bsd, 리눅스, freebsd, nacl, netbsd, openbsd, 솔라리스, 잠자리, bsd, notbsd, 안드로이드, 스텁🎜

  5. 일반적으로 애플리케이션의 주요 입구는 main.go이거나 애플리케이션의 이름이 모두 소문자여야 합니다. 예를 들어 MyBlog의 입구는 myblog.gomyblog.go

2. 常量命名

目前在网络上可以看到主要有两种风格的写法

  1. 第一种是驼峰命名法，比如 appVersion

  2. 第二种使用全大写且用下划线分词，比如 APP_VERSION

这两种风格，没有孰好孰弱，可自由选取，我个人更倾向于使用第二种，主要是能一眼与变量区分开来。

如果要定义多个变量，请使用 括号 来组织。

const (
  APP_VERSION = "0.1.0"
  CONF_PATH = "/etc/xx.conf"
)

3. 变量命名

和常量不同，变量的命名，开发者们的喜好就比较一致了，统一使用 驼峰命名法

2. 상수 이름 지정

    현재 사용할 수 있는 주요 스타일은 두 가지가 있습니다. 인터넷에서 본 글쓰기 방법

  1. 첫번째는 낙타 appVersion🎜🎜🎜

    두 번째 type은 APP_VERSION과 같이 모두 대문자와 밑줄이 그어진 단어 분할을 사용합니다.🎜🎜

🎜이 두 가지 스타일 중 더 좋고 약한 것은 없으며 개인적으로 두 번째 스타일을 선호합니다. 변수와 한눈에 구별됩니다. 🎜🎜여러 변수를 정의하려면 괄호를 사용하여 정리하세요. 🎜
// A GonicMapper that contains a list of common initialisms taken from golang/lint
var LintGonicMapper = GonicMapper{
    "API":   true,
    "ASCII": true,
    "CPU":   true,
    "CSS":   true,
    "DNS":   true,
    "EOF":   true,
    "GUID":  true,
    "HTML":  true,
    "HTTP":  true,
    "HTTPS": true,
    "ID":    true,
    "IP":    true,
    "JSON":  true,
    "LHS":   true,
    "QPS":   true,
    "RAM":   true,
    "RHS":   true,
    "RPC":   true,
    "SLA":   true,
    "SMTP":  true,
    "SSH":   true,
    "TLS":   true,
    "TTL":   true,
    "UI":    true,
    "UID":   true,
    "UUID":  true,
    "URI":   true,
    "URL":   true,
    "UTF8":  true,
    "VM":    true,
    "XML":   true,
    "XSRF":  true,
    "XSS":   true,
}

3. 변수 이름 지정

🎜상수와 달리 변수 이름 지정은 개발자들 사이에서 더 일관되게 사용됩니다.CamelCase🎜🎜 🎜🎜비교적 간단한 환경(적은 수의 객체와 강력한 타겟팅), 전체 단어는 단일 문자로 축약될 수 있습니다. 예: user는 u🎜로 작성됩니다.

  • 若该变量为 bool 类型，则名称应以 Has, Is, Can 或 Allow 开头。例如：isExist ，hasConflict 。

  • 其他一般情况下首单词全小写，其后各单词首字母大写。例如：numShips 和 startDate 。

  • 若变量中有特有名词（以下列出），且变量为私有，则首单词还是使用全小写，如 apiClient。

  • 若变量中有特有名词（以下列出），但变量不是私有，那首单词就要变成全大写。例如：APIClient，URLString

    • 这里列举了一些常见的特有名词：

    // A GonicMapper that contains a list of common initialisms taken from golang/lint
var LintGonicMapper = GonicMapper{
    "API":   true,
    "ASCII": true,
    "CPU":   true,
    "CSS":   true,
    "DNS":   true,
    "EOF":   true,
    "GUID":  true,
    "HTML":  true,
    "HTTP":  true,
    "HTTPS": true,
    "ID":    true,
    "IP":    true,
    "JSON":  true,
    "LHS":   true,
    "QPS":   true,
    "RAM":   true,
    "RHS":   true,
    "RPC":   true,
    "SLA":   true,
    "SMTP":  true,
    "SSH":   true,
    "TLS":   true,
    "TTL":   true,
    "UI":    true,
    "UID":   true,
    "UUID":  true,
    "URI":   true,
    "URL":   true,
    "UTF8":  true,
    "VM":    true,
    "XML":   true,
    "XSRF":  true,
    "XSS":   true,
}

    4. 函数命名

    1. 函数名还是使用 驼峰命名法

    2. 但是有一点需要注意，在 Golang 中是用大小写来控制函数的可见性，因此当你需要在包外访问，请使用 大写字母开头

    3. 当你不需要在包外访问，请使用小写字母开头

    另外，函数内部的参数的排列顺序也有几点原则

    1. 参数的重要程度越高，应排在越前面

    2. 简单的类型应优先复杂类型

    3. 尽可能将同种类型的参数放在相邻位置，则只需写一次类型

    5. 接口命名

    使用驼峰命名法，可以用 type alias 来定义大写开头的 type  给包外访问。

    type helloWorld interface {
    func Hello();
}

type SayHello helloWorld

    当你的接口只有一个函数时，接口名通常会以 er 为后缀

    type Reader interface {
    Read(p []byte) (n int, err error)
}

    5. 注释规范

    注释分为

    5.1 包注释

    1. 位于 package 之前，如果一个包有多个文件，只需要在一个文件中编写即可

    2. 如果你想在每个文件中的头部加上注释，需要在版权注释和 Package前面加一个空行，否则版权注释会作为Package的注释。

    // Copyright 2009 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.
package net
    1. 如果是特别复杂的包，可单独创建 doc.go 文件说明

    5.2 代码注释

    用于解释代码逻辑，可以有两种写法

    单行注释使用 // ，多行注释使用 /* comment */

    // 单行注释

/*
多
行
注
释
*/

    另外，对于代码注释还有一些更加苛刻的要求，这个看个人了，摘自网络：

    • 所有导出对象都需要注释说明其用途；非导出对象根据情况进行注释。

    • 如果对象可数且无明确指定数量的情况下，一律使用单数形式和一般进行时描述；否则使用复数形式。

    • 包、函数、方法和类型的注释说明都是一个完整的句子。

    • 句子类型的注释首字母均需大写；短语类型的注释首字母需小写。

    • 注释的单行长度不能超过 80 个字符。

    • 类型的定义一般都以单数形式描述：

      // Request represents a request to run a command.  type Request struct { ...

    • 如果为接口，则一般以以下形式描述：

      // FileInfo is the interface that describes a file and is returned by Stat and Lstat.
type FileInfo interface { ...

    • 函数与方法的注释需以函数或方法的名称作为开头：

      // Post returns *BeegoHttpRequest with POST method.

    • 如果一句话不足以说明全部问题，则可换行继续进行更加细致的描述：

      // Copy copies file from source to target path.
// It returns false and error when error occurs in underlying function calls.

    • 若函数或方法为判断类型（返回值主要为 bool 类型），则以 8a11bc632ea32a57b3e3693c7987c420 returns true if 开头：

      // HasPrefix returns true if name has any string in given slice as prefix.
func HasPrefix(name string, prefixes []string) bool { ...

    5.3 特别注释

    • TODO：提醒维护人员此部分代码待完成

    • FIXME：提醒维护人员此处有BUG待修复

    • NOTE：维护人员要关注的一些问题说明

    6. 包的导入

    单行的包导入

    import "fmt"

    多个包导入，请使用 () 来组织

    import (
  "fmt"
  "os"
)

    另外根据包的来源，对排版还有一定的要求

    1. 标准库排最前面，第三方包次之、项目内的其它包和当前包的子包排最后，每种分类以一空行分隔。

    2. 尽量不要使用相对路径来导入包。

    import (
    "fmt"
    "html/template"
    "net/http"
    "os"

    "github.com/codegangsta/cli"
    "gopkg.in/macaron.v1"

    "github.com/gogits/git"
    "github.com/gogits/gfm"

    "github.com/gogits/gogs/routers"
    "github.com/gogits/gogs/routers/repo"
    "github.com/gogits/gogs/routers/user"
)

    7. 善用 gofmt

    除了命名规范外，Go 还有很多格式上的规范，比如

    1. 使用 tab 进行缩进

    2. 一行最长不要超过 80 个字符

    因此在格式上的问题，你大部分都可以放心交由 gofmt 帮你调整。关于 gofmt 的文章还在写，应该这两天就会更新。你可以过两天再来看看。

    위 내용은 盘一盘 Go 语言中的编码规范의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

    golang 常量 if 子类 bool 接口 对象 windows android linux bug unix
    성명：
    이 기사는 Go语言进阶学习에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제
    이전 기사：다음 기사：

    관련 기사

    더보기