Red Hat Summit Red Hat SummitSupportConsoleDéveloppeursCommencer un essaiContact

Ce contenu n'est pas disponible dans la langue sélectionnée.

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
Copier lien

3.2. Formatting code
Copier lien

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, enter: 

    $ 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
Copier lien

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

  • Show differences in your code in a given path: 

    $ 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
Copier lien

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

Procedure

  1. To simplify code in a given path, enter: 

    $ gofmt -s -w <code_path>
    Copy to Clipboard Toggle word wrap

    Replace <code_path> with the path to the code you want to simplify.

  2. To apply the changes, enter: 

    $ 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
Copier lien

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

Procedure

  1. To refactor your code in a given path, enter: 

    $ gofmt -r -w <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.

  2. To apply the changes, enter: 

    # gofmt -w <code_path>
    Copy to Clipboard Toggle word wrap

    Replace <code_path> with the path to the code you want to format.

Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat