Coding Standard CPP
Por: trenthor • 24/10/2016 • Trabalho acadêmico • 487 Palavras (2 Páginas) • 243 Visualizações
Engenharia de Software
C++ Code Standard
Arquivos de Cabeçalho
Todo arquivo .cpp deve contar um arquivo .h associado, com exceção do arquivo principal contendo a função main().
Define
Todos os arquivos de cabeçalho devem utilizar o macro #define para evitar inclusões multiplas. O formato deve ser
Funções Inline
Funções inline devem ser utilizadas somente para funções com menos de 10 linhas.
Nomes de Variáveis
Nomes de variáveis devem descrever a função da variável. Nomes desconexos como “aux1” não são permitidos.
Nomes de Variáveis Comuns
Nomes de variáveis comuns devem minúsculos, com um símbolo de 'underline' separando palavras.
Nomes de Classes
Nomes de classes devem ser iniciados por letra maiúscula.
Nomes de Constantes
Variáveis que assumem valores constantes durante todo o código, ou seja variáveis do tipo const ou constexpr devem iniciar com um 'k'.
Nomes de Funções
Nomes de funções devem ser iniciados com letras maiúsculas.
Nomes de Macros
Nomes de macros devem ser inteiros em letras maiúsculas, com palavras separadas por símbolos de 'underline'.
Comentários
Comentários devem utilizar a sintaxe “//” ou “/* */”, mas somente um deles durante todo o código.
Variáveis Globais
Todas as variáveis globais devem conter um comentário explicando sua utilização e o motivo de ser global.
Comentários TODO
Comentários do tipo TODO devem ser utilizados em linhas de código que devem ser aprimoradas posteriormente, indicando quais modificações devem ser feitas. Comentários desse tipo devem iniciar com a string “TODO”, em maiúsculo, seguido de um identificador do autor melhor relacionado com o problema a ser melhorado indicado pelo comentário.
Comprimento das Linhas
Cada linha de código deve conter no máximo 80 caracteres.
Indentação
A indentação deve ser feita com uma tabulação. As linhas de código devem respeitar a indentação, com indentações diferentes para diferentes funções, classes, etc. Chaves, colchetes e parênteses, quando estendidos em mais de uma linha, devem iniciar na mesma linha que sua respectiva função ou classe e fechar na linha seguinte a última linha de código pertencente a esta mesma função/classe, respeitando a indentação.
...