美文网首页Golang进阶
【Golang】goimport格式规范

【Golang】goimport格式规范

作者: qishuai | 来源:发表于2018-02-20 13:32 被阅读9次

go import格式规范

对于go import的格式容易被忽略,但是标准的import会让代码阅读者一目了然。import的格式要求是将标准库、当前工程包、golang官方包、初始化包和github.com仓库的引入进行分类、排序,在不容分类间使用空行进行区分。

在goland和IDEA软件中,已经为我们集成了自动化选项。这里介绍一下:

  1. 找到软件的首选项,Mac下直接按command + ,进入。在window平台下,先进入首选项,在搜索栏输入imports即可找到。按照图片的选项选择即可
配置
  1. 看一下区别,修改前:
import (
    "path/filepath"

    "bytes"
    "fmt"

    "github.com/btcboost/copernicus/orm"

    "strconv"

    "golang.org/x/text/currency"

    _ "github.com/go-sql-driver/mysql"

    "github.com/btcboost/copernicus/orm/database"
    "github.com/btcboost/copernicus/conf"
)

修改后

import (
    "bytes"
    "fmt"
    "path/filepath"
    "strconv"
    
    "golang.org/x/text/currency"
    
    _ "github.com/go-sql-driver/mysql"
    
    "github.com/btcboost/copernicus/conf"
    "github.com/btcboost/copernicus/orm"
    "github.com/btcboost/copernicus/orm/database"
)

小技巧: 如果我们当前项目的import已经是乱成一团,那么通过手动格式化将是灾难性的。小技巧来了,将import代码块部分或全部注释,然后保存command + s, 格式就自动调整了(对于gopath中存在重名的包引入,要注意其引入的正确性)。

有人会说这也没什么区别呀,但是如果一个文件中引入了大量的包,各种类型的包都有,那对于代码阅读者将是灾难。另外对于一个项目,如果保持go import格式统一,不光代码美观,还能体现一个团队对于细节的追求。

相关文章

  • 【Golang】goimport格式规范

    go import格式规范 对于go import的格式容易被忽略,但是标准的import会让代码阅读者一目了然。...

  • Go 学习笔记 11 | Golang 接口详解

    一、Golang 接口 Golang 中接口定义了对象的行为规范,只定义规范不实现。接口中定义的规范由具体的对象来...

  • Golang 专栏

    简介 整理 Golang 相关文章,方便大家阅读。 目录 golang 编程规范 - 项目目录结构[https:/...

  • Golang 开发规范

    Golang 开发规范 <官方英文版> : https://github.com/golang/go/wiki/C...

  • Golang Template

    最近刚好有个task是要用Golang把Junit的XML格式report转换成HTML格式,便学习了Golang...

  • Golang字符串格式化

    Golang字符串格式化

  • 运维大神如何使用 Golang 日志监控应用程序

    本文导航1、Golang 日志基础 使用 Golang “log” 库 2、为你 Golang 日志统一格式 JS...

  • 格式规范

    格式规范会让交流的文本变得流畅和可预期。自有它的作用。 不过这个事情也繁琐得很,让人有逃避拖延的心理...

  • 天高iOS代码写作规范

    @(代码写作规范) [TOC] 一、文件名规范 命名格式 通用格式: 命名规则: Controller: 模型: ...

  • 阿里规范

    命名规范 代码格式 [官方地址] 注释格式

网友评论

    本文标题:【Golang】goimport格式规范

    本文链接:https://www.haomeiwen.com/subject/npkgtftx.html