golang编程01-go文件基本结构

基本结构

go文件

golang的脚本文件具备以下几个特点:

1.以go为文件后缀

例如

abc.go
getApi.go
get_info.go

文件名推荐采用蛇形命名法，以及不要包含中文。

2.文件结构

//最上层是包名，C系老传统，类似命名空间
package 包名

//导入其他包
import xx

//本文件的内容
func xx(){
    xx
}

var a int = 5

3.访问属性

• 同目录下的所有文件包名相同
• 在同一个包内可以任意访问，不能声明同名标识
• 标识(即变量、函数名、接口等)严格区分大小写
• 小写字母开头的标识为私有标识，包外无法访问。

入口文件

正如前端工程都有入口文件一样，例如main.js、index.js、app.js。

golang的工程也需要一个入口文件，入口文件具有以下特点:

• 包名必须为main
• 必须包含一个main函数，该函数是整个工程的入口

示例

package main

import "fmt"

func main(){
	fmt.Print("hello world!!\n")
}

语句结束符

和其他C系语言一样，golang的语句分隔符为;,但是一般情况下会由工程自动补全。

如果你打算将多个语句写在同一行，它们则必须使用 ; 人为区分，但在实际开发中我们并不鼓励这种做法。

package main

import "fmt"

func main(){
    //语句1
	fmt.Print("hello world!!\n")
    //语句2
    fmt.Print("hello world!!\n")
}

注释

单行注释

也叫行注释，是以//开头的注释，用于在单行中注释代码。行注释通常用于解释特定行的作用、实现细节、注意事项等。

//这是单行注释

多行注释

也叫块注释，是以/*开头和*/结尾的注释，可以跨多行注释代码块。块注释通常用于注释函数、方法、包、重要功能模块等。

/*
	这是多行注释
*/

标识符

标识符用来命名变量、类型等程序实体。

变量、常量、函数名、类型名、结构字段等都是标识符号。

命名规则

• 标识符的名称必须以字母或下划线（_）开头。并且名称中可能包含字母“ a-z”或“ A-Z”或数字0-9，以及字符“ _”。
• 标识符的名称不能以数字开头。
• 标识符的名称区分大小写。
• 关键字不能用作标识符名称。
• 标识符名称的长度没有限制，但是建议仅使用4到15个字母的最佳长度。
• 运算符不能出现在标识符中，例如a+b非法。

常用命名规范

规范不要求强制遵守，但是同一个项目遵守同一规范有利于后期维护。

变量命名规范

• 变量名应该使用驼峰命名法（Camel Case），例如 myVariable。
• 变量名应尽量具有描述性，能够清晰表达变量的用途和含义。
• 对于布尔类型的变量，可以使用形容词或动词+ed 形式的命名，例如 isReady、completed。
• 对于计数器或迭代器变量，可以使用单个字母命名，如 i、j、k。

常量命名规范

• 常量应该使用全大写字母命名，例如 MAX_SIZE。
• 多个单词之间可以使用下划线分隔，例如 DEFAULT_TIMEOUT。
• 常量命名应具有清晰的含义，尽量避免使用无意义的缩写。

函数名命名规范

• 函数名应该使用驼峰命名法（Camel Case），例如 getUserInfo。
• 函数名应尽量具有描述性，能够清晰表达函数的功能和用途。
• 函数名应当以动词开头，例如 calculateTotal、getUserName。
• 对于返回布尔类型结果的函数，命名时可以使用形容词或动词+ed形式，例如 isValid、isFinished。

结构体命名规范

• 结构体名应使用驼峰命名法（Camel Case），首字母大写，例如 UserInfo。
• 结构体名应尽量具有描述性，能够清晰表达结构体的含义和作用。
• 结构体名应使用名词或名词短语，避免使用动词或动词短语。

接口命名规范

• 接口名应该使用驼峰命名法（Camel Case），首字母大写，例如 OrderService。
• 接口名应具有描述性，能够清晰表达接口的功能和用途。
• 接口名应以 er 结尾，表示该接口描述了一个对象的行为，例如 Reader、Writer。

包名命名规范

• 尽量使用单个英文单词作为包名，避免使用复数形式。
• 包名应该清晰地描述包所提供的功能，尽量避免使用不相关的名称。
• 包名应避免与标准库或其他第三方库冲突，最好使用全局唯一的名字。