Sunteți pe pagina 1din 2

Capitulo 1 Cdigo Limpo

O cdigo a mais formal e detalhada especificao possvel para dizer o que uma mquina precisa de executar e ainda afirma que no importa o quanto o nvel de abstrao das linguagens de programao e o nmero de linguagens de domnio especifico cresa ainda vamos ter cdigo, que vai precisar ser detalhado, formal e preciso o bastante para que possa ser entendido e executado por uma mquina. A importncia do bom e organizado cdigo extrema e pode trazer abaixo o desenvolvimento de software e a organizao que o produz. O cdigo ruim impede, atrasa, gera bugs. E se, enfim.esse cdigo for deixado para ser melhorado mais tarde, podemos aplicar de LeBlanc: Mais tarde igual a nunca. Programadores sempre encaram o enigma primordial de escolher entre bagunar o cdigo e conseguir alcanar o objetivou ou limpar o cdigo e no conseguir chegar l. O interessante deste enigma que verdadeiros profissionais sabem que se bagunarem o cdigo j no vo mais alcanar os seus objetivos. O fato que cdigo bagunado sempre um atraso, at mesmo para quem o produziu. O cdigo limpo como uma pintura que deve ser pintada atravs do desenvolvimento de senso de codificao e uso disciplinado de regras que so aplicadas com o objetivo de tornar o cdigo o mais limpo o possvel. O programador que deseja obter o cdigo limpo vai ter que de varias maneiras pegar uma tela em branco e depois de muitas transformaes chegar at o objetivo final.

Captulo 2: nomes significantes


O captulo trs um conjunto de regras que resulta em uma boa prtica de nomeao para funes, variveis, constantes e tudo o que for preciso dentro do software desenvolvido. O principal objetivo dessas regras manter o fcil entendimento, eliminar ambigidades, codificaes desnecessrias, facilitar a manuteno e mudana de cdigo. Uma lista com as principais regras esta a seguir: Use nomes que revelem as intenes. Evite falta de informao. Faa distines significantes. Use nomes pronunciveis. Use nomes pesquisveis. Evite codificaes Evite mapeamento mental. Evite piadas. Use um nome por conceito e padronize esse nome para todo seu cdigo. Use os nomes dos domnios de soluo. Caso no haja outros nomes use nomes dos domnios de problemas. Adicione contexto significante.

Finalmente no adicione texto intil.

Captulo 4: comentrios
Comentrios bons geralmente so comentrios que no existem. Em geral comentrios em sua maior parte existem para corrigir as falhas causadas por nossa falta de capacidade em nos expressar em nossos cdigos. O nico detentor da verdade sobre o funcionamento do cdigo ele mesmo. Isso no quer dizer que no haja comentrios em lugares ruins, existem alguns motivos pelos quais devemos comentar o cdigo como: Motivos legais. Comentrios informativos. Explicao de intenes. Clarear os significados. Comentrios TODO. Avisos de conseqncias. Amplificaes de importncia. Javadocs(em APIs pblicas).

O restante so comentrios ruins, listas de comentrios desnecessrios, sobrecarga de comentrios, comentrios com muita informao, em formatos diferentes de texto ou cdigo (HTML, por exemplo), relaes entre comentrios e cdigos no bvias, javadocs em APIs no publicas devem ser eliminados. Comentrios que apresentam gerncia de mudana devem ser deixados para as ferramentas de gerenciamento.

Captulo 5: formatando
A importncia de se formatar o cdigo se baseia no fato de que as mudanas em seu cdigo vo ser freqentes e talvez seu cdigo no sobreviva, porm o estilo e a legibilidade do seu cdigo tero grandes influncias qualquer mudana que for feita e sempre estaro presentes. A metfora do jornal nos ajuda a ter uma idia geral de como o cdigo devera ser formatado. No jornal nos encontramos artigos de variados tamanhos, falando de vrios assuntos. Um artigo conta uma narrativa ou discutem determinado assunto, todos adotando um padro de escrita. Normamelmente quando lemos um artigo esperamos que os principais conceitos venham em primeiro lugar e a medida que vamos chegando ao seu fim queremos ver os conceitos tcnicos. Assim deve ser um cdigo, ele deve obedecer aos padres de formatao de uma equipe, pode variar de tamanho, desde que no se alongue demais e fique bem no todo. Como em sesses os conceitos mais parecidos devem sempre estar mais prximos um dos uns outros, as variveis devem ser declaradas de maneira pertencer escopo em que forem utilizadas, salvo algumas excees.

S-ar putea să vă placă și