====Regras e Convenções para Nomeclatura==== ===.Net=== ==Nomes de Classes== * Toda classe deve começar com letra Maiúscula. * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À). * Não deve possuir caracteres especias (@, !, %, &). * Caso um classe possua um nome composto, a primeira letra de cada palavra deverá começar com letra maiúscula. Exemplos: * PrimeiraClasse * MinhaClasse * OlaMundo ==Nomes de Atributos== * Todo atributo deve começar com letra Maiúscula. * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À). * Não deve possuir caracteres especias (@, !, %, &). * Caso um atributo possua um nome composto, a primeira letra de cada palavra deverá começar com letra maiúscula. Exemplos: * PrimeiroAtributo * Atributo * ColecaoDeAtributos ==Nomes de Métodos== * Métodos (funções) podem começar com qualquer letra maiúscula, não podem possuir acentos e não podem começar com números. * Caso o nome de um método seja composto por mais de uma palavra, a primeira letra da segunda palavra e das palavras posteriores deve ser em maiúscula. * Deve estar em português ou inglês, não os dois, escolher uma linguagem e adotar como padrão para o projeto; * Deve possuir um nome de fácil entendimento e que explique bem o que o método faz; Exemplos: * Imprimir() * ImprimirTela() * CalcularMedia() ==Nomes de Constantes== * Constantes devem ser escritos em letras maiúsculas. Usamos o underline (“_”) para separar nomes compostos. Exemplos: * TAMANHO * PARAR_DE_EXECUTAR * PI * TESTE_JOGO ==Nomes de Interfaces== * Toda interface deve começar com letra Maiúscula I seguida por outra letra maiuscula. * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À). * Não deve possuir caracteres especias (@, !, %, &). * Caso uma interface possua um nome composto, a primeira letra deve ser I e em seguida de cada palavra deverá começar com letra maiúscula. Exemplos: * IRepositoryAluno * IRepository ==Nome de variáveis== * Variáveis podem começar com qualquer letra minúscula (sem acento) e os caracteres $ ou _, porém não podem começar com números. * Caso o nome de um pacote seja composto por mais de uma palavra, a primeira letra da segunda palavra e das palavras posteriores deve ser em maiúscula. Exemplos: * _x * $a * b1 * c * calculadoraCientifica ==Nomes de variáveis de Repositório== * Toda variável de Repositório deve começar com (_) seguida de uma letra minúscula. * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À). * Caso uma variável de Repositório possua um nome composto, deve começar com (_) em seguida cada palavra deverá começar com letra maiúscula. Exemplos: * _repositorioAluno * _repositorio ==Nomes de variáveis de Serviço== * Toda variável de Serviço deve começar com (_) seguida de uma letra minúscula. * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À). * Caso uma variável de Serviço possua um nome composto, deve começar com (_) em seguida cada palavra deverá começar com letra maiúscula. Exemplos: * _servicoAluno * _servico ==Nomes de ações de Controller== * Toda ação deve começar com letra Maiúscula. * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À). * Não deve possuir caracteres especias (@, !, %, &). * Caso uma ação possua um nome composto, a primeira letra de cada palavra deverá começar com letra maiúscula. Exemplos: * PrimeiraAcao * Acao === CSS/HTML === == IDs e Classes == * O ID ou Classe deve estar escrito todo em minúsculo; * Caso tenha mais de uma palavra deve estar separado por traço; * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À). * Não deve possuir caracteres especias (@, !, %, &). Exemplos: * cabecario * cabecario-do-diario === Javascript === == Nome de métodos == * Métodos (funções) podem começar com qualquer letra minúscula, não podem possuir acentos e não podem começar com números; * Caso o nome de um método seja composto por mais de uma palavra, a primeira letra deve ser minúscula e as demais palavras devem começar com letra maiúscula; * Deve estar em português ou inglês, não os dois, escolher uma linguagem e adotar como padrão para o projeto; * Deve possuir um nome de fácil entendimento e que explique bem o que o método faz; Exemplo: * imprimir(); * imprimirTela(); * calcularMedia(); == Nome de variáveis, constantes e parâmetros == * Podem começar com qualquer letra minúscula (sem acento), porém não podem começar com números; * Caso o nome da variável, constante ou parâmetros e seja composto por mais de uma palavra, a primeira letra da segunda palavra e das palavras posteriores deve ser em maiúscula. Exemplo: * nome; * nomeDoAluno; * salvarAluno(aluno); * buscarAluno(nomeDoAluno); == Nome de arquivos == * O nome do arquivo deve estar todo em minúsculo; * Não deve possuir caracteres com acento (ç, á, î, ã, Á, À); * Não deve possuir caracteres especias (@, !, %, &); * Caso tenha mais de uma palavra deve estar separado por traço; Exemplo: * arquivo; * arquivo-do-diario; === Git === == Nome dos branchs == * feature/nome-da-feature#123456 (branch criado para features, #123456 representa o número da feature ou PBI) * bug/nome-do-bug#123456 (branch criado para bugs, #123456 representa o número do bug) * ref/nome-da-refatoracao#123456 (branch criado para refatorações, #123456 representa o número da refatoração)