Portal
Bom, é muito comum para os que iniciaram agora na programação e não tiveram acesso a informações necessárias sobre as boas práticas na hora de programar. Essas boas práticas são referentes ao código, nomenclatura de métodos e variáveis, comentários nos métodos e identação.
Nome de métodos e variáveis
Sinceramente, creio que isso não afeta apenas a mim, mas também a todos os programadores que quando leem um código com variáveis com nomes tipo: data, ret, temp...
Isso me deixa muito, muito nervoso porque como que vou saber ao que se refere? Esses nomes não significam nada no código, não explicam absolutamente nada e apenas fazem com que terceiros se percam nas centenas de linhas existentes.
Sempre tente usar nomes explicativos paras as variáveis e métodos, caso a variável guarde o nome de uma pessoa, o nome da variável deverá ser name. Isso também vale para os métodos.
Eu particularmente sou a favor de utilizar na nomenclatura apenas inglês, isso se deve ao fato da própria linguagem já apresentar os termos em inglês e continuar no padrão ajuda a tornar o código legível. Mas por favor, não misturem inglês com português e forme uma zona em cada linha.
Em C# tenho a prática de utilizar Camel Case pra nomear algumas variáveis e Pascal Case para métodos. Bem, Ruby tem uma forma “diferente” de nomenclatura que ao invés de utilizar letras maiúsculas e minúsculas pra separar as palavras dentro do método, é utilizado o underline (_).
Código identado
Esse ponto é fundamental, pior do que pegar um código com variáveis e métodos com nomes “exóticos” é pegar um código não identado.
Identar um código é ressaltar as linhas, ou seja, definir uma estrutura para os método. Não sou muito bom com palavras, então vai as imagens:
Não identado:
Identado:
Viram a diferença? E blocos de código contendo váris if ou coisas do tipo, o fato de não estar identado tornaria o código praticamente ilegível.
Comentários
Agora vem, é comum que muitos não adotem a prática de comentar os códigos, eu mesmo odiava fazer isso até que peguei um projeto criado por um outro programador e continha códigos muito desorganizados e sem comentário algum, isso me fez perder horas preciosas do meu dia.
Pois bem, na imagem acima vocês puderam ver um bom exempli de como se comentar um código em Ruby, tendo a classe o “#==”, métodos apenas “#--“ e tudo isso no mesmo nível da linha, ou seja: identado.
Espero que tenham gostado, escrevi esse pequeno artigo, pois como expliquei no início é muito comum vermos novos programadores escrevendo códigos cada vez mais confusos e embaralhados.
Nome de métodos e variáveis
Sinceramente, creio que isso não afeta apenas a mim, mas também a todos os programadores que quando leem um código com variáveis com nomes tipo: data, ret, temp...
Isso me deixa muito, muito nervoso porque como que vou saber ao que se refere? Esses nomes não significam nada no código, não explicam absolutamente nada e apenas fazem com que terceiros se percam nas centenas de linhas existentes.
Sempre tente usar nomes explicativos paras as variáveis e métodos, caso a variável guarde o nome de uma pessoa, o nome da variável deverá ser name. Isso também vale para os métodos.
Eu particularmente sou a favor de utilizar na nomenclatura apenas inglês, isso se deve ao fato da própria linguagem já apresentar os termos em inglês e continuar no padrão ajuda a tornar o código legível. Mas por favor, não misturem inglês com português e forme uma zona em cada linha.
Em C# tenho a prática de utilizar Camel Case pra nomear algumas variáveis e Pascal Case para métodos. Bem, Ruby tem uma forma “diferente” de nomenclatura que ao invés de utilizar letras maiúsculas e minúsculas pra separar as palavras dentro do método, é utilizado o underline (_).
Código identado
Esse ponto é fundamental, pior do que pegar um código com variáveis e métodos com nomes “exóticos” é pegar um código não identado.
Identar um código é ressaltar as linhas, ou seja, definir uma estrutura para os método. Não sou muito bom com palavras, então vai as imagens:
Não identado:
Identado:
Viram a diferença? E blocos de código contendo váris if ou coisas do tipo, o fato de não estar identado tornaria o código praticamente ilegível.
Comentários
Agora vem, é comum que muitos não adotem a prática de comentar os códigos, eu mesmo odiava fazer isso até que peguei um projeto criado por um outro programador e continha códigos muito desorganizados e sem comentário algum, isso me fez perder horas preciosas do meu dia.
Pois bem, na imagem acima vocês puderam ver um bom exempli de como se comentar um código em Ruby, tendo a classe o “#==”, métodos apenas “#--“ e tudo isso no mesmo nível da linha, ou seja: identado.
Espero que tenham gostado, escrevi esse pequeno artigo, pois como expliquei no início é muito comum vermos novos programadores escrevendo códigos cada vez mais confusos e embaralhados.
