Dicas de programação

Dicas gerais sobre como escrever um bom código


Como nomear uma função

Escolher bons nomes de função é parte essencial de escrever um bom código. Considere as recomendações a seguir ao nomear sua função.

Escolha nomes de função significativos

Ao nomear sua função, você precisa ter clareza sobre o que ela faz. Por exemplo, a função get(studentId, subject) não tem um nome significativo e, por isso, não fica claro o que ela faz. Ela pode estar buscando a nota do aluno na disciplina ou consultando a situação da matrícula. Um nome melhor seria getStudentGrade(studentId, subject), pois ele comunica com precisão o que a função faz.

Não deixe o nome da função longo demais

Cuidado para não deixar o nome de uma função longo demais. Por exemplo, checkStudentFailOrPassOrMeritOrDistinction(mark) é um nome de função desnecessariamente longo. Quanto mais longo o nome, mais difícil fica lembrar dele e mais espaço ele ocupa na tela do computador.

Não deixe o nome da função curto demais

Por outro lado, um nome de função curto demais também pode confundir quem lê o código. Por exemplo, checkFPMD(mark) é um nome de função ruim, porque não é óbvio de imediato o que 'FPMD' significa.

Use um nome que todo mundo entenda.

O nome da sua função deve ser compreensível para qualquer pessoa que leia seu código. Por exemplo, um nome de função obscuro como DeathStar() pode ser divertido para você, mas o nome não comunica seu propósito e pode confundir outros desenvolvedores que leiam seu código.

Escolha uma única convenção para nomear operações

Mantenha uma única convenção para nomear operações que fazem a mesma coisa. Por exemplo, se você chama a função que obtém o nome de um aluno de getStudentName(), não use um verbo diferente no nome da função que obtém a nota do aluno (por exemplo, retrieveStudentGrade()).

Evite usar a mesma palavra para dois propósitos

Por exemplo, não continue usando add quando quiser colocar um grupo de itens em uma coleção se você já usou esse nome para a adição de dois números. Use insert ou append em vez disso.