O que é Google Java Style Guide?

Etimologia e Padrões do Código Institucional

O Guia de Estilo Java do Google é um conjunto de regras desenvolvido pelo Google, uma das maiores empresas de tecnologia do mundo, para que dezenas de milhares de seus engenheiros possam trabalhar sem problemas na mesma base de código. Desde a sua primeira publicação, tornou-se um padrão de facto não apenas no Google, mas também no ecossistema global de código aberto e no mundo do software empresarial.

Guia; Ele traça todos os limites formais e estruturais que um arquivo Java deve ter, desde a estrutura do arquivo de origem até as declarações do pacote, desde regras de indentação até convenções de nomenclatura de classes e variáveis, desde a formatação Javadoc até o gerenciamento de erros. Em um projeto de software, todos deixando espaços ou abrindo parênteses de acordo com seu gosto pessoal levam a discussões desnecessárias e perda de tempo durante revisões de código. O Guia de estilo Java do Google elimina essas discussões subjetivas, permitindo que os desenvolvedores se concentrem apenas na lógica de negócios.

Aprofundamento Técnico e Regras Básicas

- Estrutura e recuo do arquivo de origem: os arquivos são sempre codificados em UTF-8. Para recuo, exatamente dois (2) espaços são usados ​​em vez de tabulações. O comprimento da linha é limitado a 100 caracteres; os parênteses são colocados no final da linha de acordo com o estilo K&R.
- Padrões de importação: Importações curinga (import java.util.*;) são proibidas. Cada classe é explicitamente importada uma por uma e classificada em ordem alfabética.
- Convenções de nomenclatura: as classes são denominadas UpperCamelCase, os métodos e variáveis ​​são denominados lowerCamelCase, as constantes são denominadas CONSTANT_CASE. Nas abreviações, apenas a primeira letra é maiúscula (XmlHttpRequest).
- Programação e Automação Defensiva: @Override é obrigatório em métodos sobrescritos. Blocos de captura deixados vazios são proibidos. As regras são verificadas automaticamente na linha CI/CD com os plugins google-java-format, Checkstyle e Spotless.
- Javadoc e padrões de comentários: comentários Javadoc são necessários para aulas gerais; As tags @param, @return e @throws são preenchidas completamente.

Dimensão Sociológica: Legibilidade e Produtividade da Equipe

Pesquisas em engenharia de software mostram que um desenvolvedor gasta mais de 80% de seu tempo lendo código existente, e não escrevendo novo código. Portanto, a legibilidade é muito mais valiosa do que a facilidade de escrita.

O Guia de estilo Java do Google permite que os desenvolvedores deixem para trás seu ego pessoal e preocupações estéticas em relação ao código e priorizem a produtividade coletiva da equipe. Para projetos que aceitam contribuições externas (solicitações pull) no mundo do código aberto, este guia é um texto de acordo universal que garante que os contribuidores possam se adaptar facilmente ao projeto.

Erros Comuns e Equívocos

- Tentando formatar manualmente: Em vez de contar os espaços um por um, o plugin google-java-format deve ser instalado no IDE e o salvamento automático do formato deve ser ativado.
- Desabilitar regras de estilo de verificação: desabilitar verificações de estilo em CI/CD quando o processo trava aumenta o débito técnico.
- Linhas de comentários excessivas: O objetivo deve ser que o código se explique, e comentários sem sentido não devem ser escritos em métodos getter/setter óbvios.

Perguntas e respostas

Termos relacionados