此内容没有您所选择的语言版本。

Chapter 3. The gofmt formatting tool


Instead of a style guide, the Go programming language uses the gofmt code formatting tool. gofmt automatically formats your code according to the Go layout rules.

3.1. Prerequisites

3.2. Formatting code

You can use the gofmt formatting tool to format code in a given path. When the path leads to a single file, the changes apply only to the file. When the path leads to a directory, all .go files in the directory are processed.

Procedure

To format your code in a given path, run:

  • On Red Hat Enterprise Linux 7:

    $ scl enable go-toolset-1.17 'gofmt -w <code_path>'
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to format.
  • On Red Hat Enterprise Linux 8:

    $ gofmt -w <code_path>
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to format.
  • On Red Hat Enterprise Linux 9:

    $ gofmt -w <code_path>
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to format.
Note

To print the formatted code to standard output instead of writing it to the original file, omit the -w option.

3.3. Previewing changes to code

You can use the gofmt formatting tool to preview changes done by formatting code in a given path. The output in unified diff format is printed to standard output.

Procedure

To show differences in your code in a given path, run:

  • On Red Hat Enterprise Linux 7:

    $ scl enable go-toolset-1.17 'gofmt -d <code_path>'
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to compare.
  • On Red Hat Enterprise Linux 8:

    $ gofmt -d <code_path>
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to compare.
  • On Red Hat Enterprise Linux 9:

    $ gofmt -d <code_path>
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to compare.

3.4. Simplifying code

You can use the gofmt formatting tool to simplify your code.

Procedure

  • To simplify code in a given path, run:

    • On Red Hat Enterprise Linux 7:

      $ scl enable go-toolset-1.17 'gofmt -s <code_path>'
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to simplify.
    • On Red Hat Enterprise Linux 8:

      $ gofmt -s <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to simplify.
    • On Red Hat Enterprise Linux 9:

      $ gofmt -s <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to simplify.
  • To apply the changes, run:

    • On Red Hat Enterprise Linux 7:

      $ scl enable go-toolset-1.17 'gofmt -w <code_path>'
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.
    • On Red Hat Enterprise Linux 8:

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.
    • On Red Hat Enterprise Linux 9:

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.

3.5. Refactoring code

You can use the gofmt formatting tool to refactor your code by applying arbitrary substitutions.

Procedure

  • To refactor your code in a given path, run:

    • On Red Hat Enterprise Linux 7:

      $ scl enable go-toolset-1.17 'gofmt -r <rewrite_rule> <code_path>'
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to refactor and <rewrite_rule> with the rule you want it to be rewritten by.
    • On Red Hat Enterprise Linux 8:

      $ gofmt -r <rewrite_rule> <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to refactor and <rewrite_rule> with the rule you want it to be rewritten by.
    • On Red Hat Enterprise Linux 9:

      $ gofmt -r <rewrite_rule> <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to refactor and <rewrite_rule> with the rule you want it to be rewritten by.
  • To apply the changes, run:

    • On Red Hat Enterprise Linux 7:

      $ scl enable go-toolset-1.17 'gofmt -w <code_path>'
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.
    • On Red Hat Enterprise Linux 8:

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.
    • On Red Hat Enterprise Linux 9:

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat