-
Notifications
You must be signed in to change notification settings - Fork 0
Stylesheet
Este documento trás uma série de convenções de codificação a serem utilizadas no projeto PCSA-Android.
1.1 Use camelCase para nomear atributos
//good example
//bad example
1.2 Use camelCase para nomear métodos e parâmetros
//good example
//bad example
1.3 Use PascalCase para nomear classes e interfaces
//good example
//bad example
1.4 Use nomes significativos para nomear atributos. Abreviações não devem ser utilizadas.
//good example
//bad example
1.5 O nome de um método deve representar o que ele significa, utilizando um verbo.
//good example
//bad example
1.6 Trate acrônimos como uma palavra
//good example
//bad example
1.7 Use SCREAMING_SNAKE_CASE para nomear constantes
//good example
//bad example
2.1 Use tabulação com tamanho 4 para identação
//good example
//bad example
2.2 O tamanho máximo de uma linha poderá ser de 110 caracteres, o comando deve ser divido em quantas linhas forem necessárias para aumentar a visibilidade do código.
//good example
//bad example
2.3 Instruções que quebram a linha devem estar alinhadas com o operador '+' na linha seguinte.
//good example
//bad example
2.4 Use uma linha em branco para separar grupos lógicos.
//good example
//bad example
2.5 As chaves serão abertas na mesma linha, não havendo espaço entre abertura da chave e o ultimo caractere da linha, e fechadas na mesma posição horizontalmente de onde foi chamada.
//good example
//bad example
2.6 Use um espaço antes e depois dos operadores =, :, ?, <, >, ==
//good example
//bad example
2.7 Não use espaços após ( e [ e antes de ) e ]
//good example
//bad example
2.8 * Em métodos cada parâmetro adicional terá uma vírgula no final da sequência e um espaço para o início do novo parâmetro.
//good example
//bad example
2.9 Não use espaços após o nome do método, if, else if, switch, for, try, catch
//good example
//bad example
3.1 Os comentários devem ser inicializados pela primeira vez com letra maiúscula e ser finalizando com ponto final para indicar que o comentário chegou ao fim.
//good example
//bad example
3.2 Para documentar um método ou uma classe, você deve usar o tipo '/ ** e * /.
//good example
//bad example
4.1 Faça um comentário no início do arquivo informando o que o código faz, essa explicação deve ser feita iniciando com letra maiúscula e terminando com ponto final.
//good example
//bad example