-
Notifications
You must be signed in to change notification settings - Fork 5
Guia de estilo de código
Regras fundamentadas para promover a acessibilidade, reutilização e eficiência do código.
Sempre nomear atributos, variáveis, constantes, métodos e classes de maneira clara. Os nomes dos atributos, variáveis e constantes devem descrever os dados que armazenam, os nomes dos métodos devem descrever as ações que executam e os nomes das classes devem descrever o objeto que modelam.
Variáveis e atributos devem ser em snake case com letras minúsculas. ex: horario_saida, cidade_origem
Classes devem ter a primeira letra maiúscula. ex: Cliente, Funcionario, Passagem
Métodos e funções devem ser em camel case. ex: alterarDados(), consultarLinhas()
Constantes devem ser em letras maiúsculas. ex: VALOR1, NUMERO_VAGAS
Utilize sempre letras minúsculas para representar tags e atributos ex: Home
Use os elementos(“tags”) para designar a função que você tem preferência: p, que serve para parágrafos, a, para links, e etc. ex: _
Use aspas duplas para os atributos html. ex:
Palavras-chave devem ser em letras maiúsculas. ex: SELECT COUNT(1) FROM tablename WHERE 1;
Nomes sempre minúsculos, entretanto, para nomes compostos, a segunda palavra deve começar com letra maiúscula.
ex: CREATE TABLE IF NOT EXISTS logistica.registrationNumber (
id INT NOT NULL,
name VARCHAR(255) NOT NULL
Para DataBases usar nomes sempre com letras minúsculas.
ex: CREATE SCHEMA IF NOT EXISTS guiaestilo DEFAULT CHARACTER SET utf8;
Sempre que for apelidar colunas utilizar da palavra chave AS para este fim. Isso garante que, se uma vírgula seja posta num local indevido, não haja erros de relacionamento. ex: SELECT ebe_ebs_sox_flag_set_for_all_crs AS sox_ok FROM tablename;
Os comentários ao longo do código devem descrever o “porquê” tal trecho de código foi implementado e não “como”.
Toda classe deve ter um trecho de comentários antes dela que tenha presente as seguinte coisas na ordem em que está descrito:
- o nome dela;
- qual a funcionalidade/objetivo dela;
- o nome do(s) autor(es).
Todo método deve ter um trecho de comentários antes dele que tenha presente as seguinte coisas na ordem em que está descrito:
- o nome dele;
- qual a funcionalidade/objetivo dele;
- o nome do(s) autor(es).
Todo atributo, variável e constante deve possuir um comentário ao lado da declaração do mesmo que forneça uma breve explicação do que ele armazena.
Para comentários em HTML, utilize a seguinte marcação ex:
Utilizar sempre que possível e necessário padrões de projetos (Observer, Adapter, DAO) minimizando a dependência entre as partes.
Utilizar outras regras de estilo próprias de cada linguagem utilizada no projeto, de forma que não confrontem com as regras aqui estabelecidas.
Quando quiser indicar uma melhoria ou alteração em um código de autoria de outra pessoa, preferir abrir “issues” ao invés de fazer “pull request” diretos no código.
Utilizar outros branches (diferentes do principal) para fazer implementações não definitivas no projeto.
Guia de Estilo EcompJr UEFS: https://github.com/EcompJr/Guia-de-estilo-EcompJr
Guias de estilo para projetos JavaScript - Airbnb, Google e GitHub: https://medium.com/code-prestige/guias-de-estilo-para-projetos-javascript-airbnb-google-e-github-eec4f4ee7dc0