Tag Archives: INTERFACE

Clean Code – Classes, Metodos, Vars, Interfaces

#8 – Bons nomes

Deixe nossos códigos clean utilizando nomes claros para nomear classes, métodos, variáveis e interfaces, sempre utilizando nomes fácil de entender, sugestivos, significativos, auto descritivos e pertinente ao propósito e projeto.

MainClass.cs

Exemplo simples:

Clean Code

public class CalculoSalColaborador
        {
            ///
<summary>
            /// Calcula o valor salario do colab. horista
            /// </summary>

            /// <param name="salario"></param>                  
            /// <param name="horaExtra"></param>
            /// <param name="desconto"></param>
            public void ObterValorSalario(int salario, int horaExtra, int desconto)
            {
                int valorTotalSalario = salario + horaExtra - desconto;
            }
        }

Sempre que necessário, faça comentários resumindo o método, ou seja, descreva seu propósito e parâmetros.

Down

public class Colaborador
    {
        public void ObterValor(double sal, double he, double dia)
        {
            int t = sal + he - dia;
        }
    }

Use nomes fáceis de entender para variáveis como salario, horaExtra e desconto, ao invés de sal, he e dia.

Para nomear métodos, faça-o descrevendo a intenção do método, como ObterValorSalario() e não ObterValor().

Clean Code!