10 Dicas para escrever mais limpo e melhor código

Sem dúvida, a programação é difícil

. É uma coisa para aprender línguas e estudar algoritmos, mas é um outro animal inteiro tentando codificar um aplicativo de trabalho complexo que não fazer você querer garra seus olhos para fora.Como aprender programação sem todo o stressComo aprender programação sem todo o stressTalvez você decidiu seguir a programação, seja para uma carreira ou apenas como um hobby. Ótimo! Mas talvez você está começando a sentir-se oprimido. Não tão grande. Aqui está a ajuda para facilitar sua viagem.consulte Mais informação

De certa forma, escrever código limpo é muito parecido desenho, cozinhar, ou fotografia - parece mais fácil do que realmente é. Então, por que se preocupar? Bem, porque os benefícios são vale a pena:

• Problemas tornam-se mais fáceis de resolver. Uma vez que você começar a pensar em código limpo, a sua abordagem às mudanças de resolução de problemas. Em vez de soluções forçando brutos, seus algoritmos e design de software tornam-se mais elegante e intencional.
• Menos tempo é desperdiçado em manutenção. código limpo é mais fácil de ler e compreender, assim você gasta menos tempo tentando descobrir o que certos segmentos realmente fazer e mais tempo na fixação, revisão, extensão, etc.
• Ideias são mais claramente comunicada. Se você está trabalhando com outros programadores, código limpo reduz a probabilidade de mal-entendidos entre todos vocês, o que também significa menos bugs no longo prazo.

Veja como você pode começar a escrever código limpo.

1. Use nomes descritivos

Quais são variáveis, classes e funções? Há muitas maneiras de responder a isso, mas quando você realmente pensa sobre isso, essas coisas são nada mais do que a interface entre um programador e a lógica subjacente de uma aplicação.

Então, quando você usar nomes pouco claras e não descritivos para as variáveis, classes e funções, você está ofuscando essencialmente a lógica da aplicação de qualquer programador que lê o código, inclusive você mesmo.

“Eu não sou um grande programmer- Eu sou apenas um bom programador com grandes hábitos.”
- Kent Beck

Video: Como escrever MELHOR

O que faz uma variável chamada dxy realmente significa? Quem sabe. Você provavelmente teria que ler todo o pedaço de código para fazer engenharia reversa de seu significado. Por outro lado, o significado de uma variável como distanceBetweenXY é imediatamente reconhecível.

O mesmo é verdade para as classes e funções. Não para resolver CalcTan () quando você pode ir para CalculateTangent () ou CalcTangentAngle () em vez de.

2. Dê a cada Classe / Função One Purpose

Alguma vez você já espiou dentro de uma função que estava a centenas ou mesmo milhares de linhas longas? Se tiver, então você sabe o quanto de uma dor que pode ser para navegar, entender e edição. Os comentários podem ajudar, mas apenas até certo ponto limitado.

“A programação é quebrar uma grande tarefa impossível em várias pequenas tarefas possíveis.”
- Jazzwant

código limpo é dividido em pedaços atômicas. Cada função deve ter como objectivo fazer uma única coisa e cada classe deve apontar para representar um conceito particular. Esta é uma simplificação, é claro, mas em caso de dúvida, mais simples é mais limpo.

Na prática, um cálculo complexo como GetCreditScore () pode precisar ser dividido em várias funções auxiliares como GetCreditReports (), ApplyCreditHistoryAge (), e FilterOutstandingMarks ().

3. Eliminar código desnecessário

Este mau hábito é um que eu ainda lutam com de vez em quando. Isso geralmente acontece assim: eu quero corrigir ou otimizar um pedaço de código que eu comentá-lo e fazer uma reescrita logo abaixo - e mesmo que ele funciona, eu manter o código antigo não só no caso.

“É possível que o software não é como qualquer outra coisa, que se destina a ser descartado: que todo o ponto é sempre a vê-lo como uma bolha de sabão”
- Alan J. Perlis

Com o tempo, eu acumular um monte de blocos comentado-out de código que não são mais necessários ainda atravancam os meus arquivos de origem. E o engraçado é que, em muitos casos, o código circundante tem evoluído de modo que o código comentado-out não funcionaria mesmo se restaurado.

A coisa é, esta prática de comentar a “código de backup” foi tornada obsoleta pela controle de origem. Se você não estiver usando algo como Git ou Mercurial, você precisa começar a usar controle de origem imediatamente. código mais limpo espera por você.O que é o Git & Porque você deve usar Controle de Versão Se você é um desenvolvedorO que é o Git & Porque você deve usar Controle de Versão Se você é um desenvolvedorComo desenvolvedores web, uma grande quantidade de tempo que tendem a trabalhar em sites de desenvolvimento local, em seguida, basta carregar tudo quando estamos a fazer. Isso é bom quando é só você e as mudanças são pequenas, ...consulte Mais informação

4. Legibilidade gt; Inteligência

Too muitos programadores confundir “código limpo” com o “código inteligente”, como se compactar dez linhas em um é de alguma forma mais limpa. Claro, ele ocupa menos espaço na tela, mas é realmente mais fácil de entender? Às vezes, talvez. Mas a maior parte do tempo? Não.

“Todo mundo sabe que a depuração é duas vezes tão duro como escrever um programa em primeiro lugar. Então, se você é tão inteligente como você pode ser quando você escrevê-lo, como você nunca vai depurá-lo?”
- Brian W. Kernighan

Eu acho que os programadores amo código inteligente, porque ela se sente como um quebra-cabeça ou enigma resolvido. Eles encontraram uma maneira especial e única para implementar algo - um “atalho” se quiserem - e quase funciona como uma validação de competências do programador.

Mas para escrever código limpo, você precisa deixar seu ego na porta.

Sempre otimizar o código para a próxima pessoa que vai lê-lo, porque com toda a probabilidade que a próxima pessoa é realmente vai ser você e não há nada mais vergonhoso do que ser incapaz de ler ou compreender a sua própria inteligência.

5. Manter um estilo de codificação consistente

eu tenho nada contra bons tutoriais de programação, mas uma das desvantagens é que os novatos acabam pegando uma ampla variedade de hábitos conflitantes, especialmente no que se refere ao estilo de codificação.O que faz um bom Programação Tutorial?O que faz um bom Programação Tutorial?Nem todos os tutoriais de programação são iguais. Alguns beneficiar você e outros acabam perdendo seu tempo. Aqui está o que procurar em um tutorial de programação de qualidade.consulte Mais informação

Video: 10 DICAS PARA TIRAR 10 NA ESCOLA | Camila Valgas

Eu não estou aqui para declarar que um estilo é melhor do que outro. Se você quiser cintas em suas próprias linhas, ir para ele. Se você deseja que preceda método chama com espaços, tudo bem. Se preferir tabulações para espaços, não deixe que me convencer do contrário.

Mas faça o que fizer, ficar consistente!

Bonito é melhor que feio.
Explícito é melhor que implícito.
Simples é melhor que complexo.
Complexo é melhor do que complicada.
Plano é melhor que aninhado.
Escassa é melhor que denso.
contagens de legibilidade.
- Tim Peters, O Zen de Python

Se você estiver indo para usar camelCaseNaming para as variáveis, não adulterar com underscore_naming. Se você usar GetThisObject () em um lugar, não vá com FetchThatObject () Em outro lugar. E se você misturar tabulações e espaços, você merece ter o seu teclado tirado.

Decida o que você vai fazer, desde o início e ficar com ela por completo. Algumas linguagens, como Python e C #, têm guias de estilo em toda a língua que você pode querer seguir.

6. Escolha a arquitetura certa

Existem muitos paradigmas e arquiteturas que você pode usar para criar seus projetos diferentes. Note como esta dica é sobre como selecionar o certo um para as suas necessidades, e não sobre a seleção do melhor um lá fora. Não há “melhor” aqui.

“Sem requisitos e design, a programação é a arte de agregar os erros para um arquivo de texto vazio.”
- Louis Srygley

Por exemplo, o padrão Model-View-Controller (MVC) é muito popular agora em desenvolvimento web, porque ajuda a manter seu código organizado e concebido de uma forma que minimize os esforços de manutenção.

Da mesma forma, o (ECS) padrão de Entidade-Component-System é muito popular agora no desenvolvimento de jogos porque ajuda a modularizar dados do jogo e lógica de uma forma que torna a manutenção mais fácil, tudo ao mesmo tempo produzindo código que é mais fácil de ler.

7. Mestre Idiomas do idioma

Uma das dificuldades em dominar uma nova linguagem de programação é aprender as nuances que o separam de todos os outros idiomas. Essas nuances pode ser a diferença entre o código feio, complicado e bonito, fácil de manter o código.7 truques úteis para dominar uma nova linguagem de programação7 truques úteis para dominar uma nova linguagem de programaçãoNão há problema em ser sobrecarregado quando você está aprendendo a código. Você provavelmente vai esquecer as coisas tão rapidamente como você aprendê-las. Estas dicas podem ajudá-lo a reter melhor tudo o que novas informações.consulte Mais informação

Video: 30 DICAS e TRUQUES QUE VOCÊ NÃO SABE no MINECRAFT!

Considere Python, Java e javascript. Eles são todos muito diferentes uns dos outros, a um grau que exige um diferente maneira de pensar, dependendo de qual linguagem você optar por usar.

“Uma linguagem que não afeta a maneira como você pensa sobre programação não vale a pena conhecer.”
- Alan J. Perlis

Considerando Python é tudo sobre o código compacto e tipagem pato, Java é mais para o lado de detalhamento e clareza. Cada língua tem expressões idiomáticas (como compreensões lista em Python) que incentivam uma certa maneira de codificação. Você faria bem em aprendê-las.

Há também “anti-padrões” com que se preocupar, que são essencialmente sub ótimas-padrões de projeto que resultam em código ineficiente, não confiável, ou de outra forma ruim. Estudo e desaprender todos os anti-padrões comuns relacionados ao idioma de sua escolha.

8. Estudo do Código de mestrado

Se você quiser escrever código limpo, a melhor coisa que você pode fazer é ver o que um código limpo parece e tentar compreender porque é do jeito que é - e não há melhor maneira de fazer isso do que através do estudo dos arquivos de origem da indústria masters.

Obviamente, você não pode simplesmente pop em sede da Microsoft e espiar os seus projectos, mas você pode sempre navegar projetos de código aberto conhecidas. Não sabe por onde começar? Experimente os projectos apresentadas no Github.Como View & Editar o código-fonte de um Open-Source AppComo View & Editar o código-fonte de um Open-Source AppAo ir de código aberto pode ser uma boa escolha, você também vai precisar investir na comunidade direita. GitHub é um dos melhores lugares para se fazer isso, não só por causa da enorme quantidade ...consulte Mais informação

“Qualquer tolo pode escrever código que um computador possa entender. Bons programadores escrever código que os seres humanos podem entender.”
- Martin Fowler, Refatoração: Aperfeiçoando o Projeto de Código Existente

Afinal, essa é uma das razões por que existem projetos de código aberto: Para que outros possam aprender com eles. E se você decidir contribuir para um projeto como este, ele pode acelerar o processo de ensino.

Pessoalmente, a primeira vez que eu vi o código realmente limpo é quando eu tropecei através do projeto Python open source de um certo hobby. O código foi tão grande elegante que eu quase terminar a programação, mas acabou me ensinando muito.

9. Escrever bons comentários

“Escrever bons comentários” é o mais antigo pedaço de conselho no mundo da programação. Na verdade, assim que os novatos são introduzidos para comentários, eles estão praticamente incentivados a comentar o mais rápido que puderem.

Mas é quase como nós oscilou demais na direção oposta. Novatos, em particular, tendem a sobre-comment - descrevendo coisas que não precisam ser descritas e perdendo o ponto do que um “bom comentário” realmente é.

“Sempre código como se o cara que acaba mantendo o seu código será um psicopata violento que sabe onde você mora.”
- John Woods

Aqui está uma boa regra de ouro: existem comentários para explicar por que um pedaço de código existe e não o que o código realmente faz. Se o código é escrito de forma limpa o suficiente, ele deve ser auto-explicativo, como o que ele faz - o comentário deve lançar luz sobre a intenção por trás por isso que ele foi escrito.

Os comentários podem ser bom para avisos (ou seja, “removendo isso vai quebrar A, B, e C”), mas para a maior parte deve descobrir coisas que não podem ser imediatamente recolhidos a partir do código (ou seja, “usar esse parâmetro porque X, Y, e Z”).

10. Refactor, Refactor, Refactor

Assim como a edição é parte do processo de escrita, refatoração é parte do processo de codificação. Uma aversão a refatoração é a maneira mais rápida de acabar com código insustentável, por isso, em muitos aspectos, esta é realmente a dica mais importante a considerar.

Em suma, a refatoração é apenas um termo extravagante para limpar o código sem afetar seu comportamento real.

“Sempre que tenho de pensar para entender o que o código está fazendo, eu me pergunto se eu posso refatorar o código para fazer essa compreensão mais imediatamente aparente.”
- Martin Fowler, Refatoração: Aperfeiçoando o Projeto de Código Existente

Um pouco de sabedoria que furou comigo é o ditado, “Não comente código ruim. Reescrevê-lo.”Como Fowler explica na citação acima, se o código já se sente confuso o suficiente para que você precisa para comentá-lo, talvez você realmente precisa refatorar-lo.

Além disso, como você editar pedaços de código aqui e ali ao longo de seu projeto, sempre deixar o código em um estado melhor do que quando você o encontrou primeiro. Pode parecer como um incômodo no momento, mas ele vai pagar no longo prazo (e pode até mesmo evitar desgaste mental).Programação Burnout: Como recuperar a sua motivação perdidaProgramação Burnout: Como recuperar a sua motivação perdidaEscrevendo todas essas linhas de código pode ser drenando fisicamente e emocionalmente. Tudo que você precisa para voltar para cima é a consciência de que a motivação pode ser recuperado.consulte Mais informação

Há sempre algo novo para aprender

Um programador que está aprendendo como escrever código limpo é semelhante a um romancista aprender a escrever prosa limpa: não há uma maneira certa de fazê-lo por si mesmo, mas há muitas maneiras erradas de fazê-lo, e isso vai demorar anos para dominar.

Algumas pessoas não têm o que é preciso e eventualmente, acabam por desistir de programação para o bem - e isso é bom porque há uma abundância de outros trabalhos techy que não envolvem codificação.6 sinais que você não está destinado a ser um programador6 sinais que você não está destinado a ser um programadorNem todo mundo é cortado para ser um programador. Se você não está completamente certo de que você está destinado a ser um programador, aqui estão alguns sinais que podem apontar na direção certa.consulte Mais informação

Mas para todos os outros, código limpo é algo que é absolutamente vale a pena lutar para, mesmo que leve o resto de sua vida para chegar lá.

Quão importante é o código limpo para você? Quais as regras que você siga para manter seu código limpo e organizado? Got quaisquer outros pedaços de sabedoria para compartilhar? Deixe-nos saber nos comentários abaixo!