Javascript: Estético e Legível

[Kvothe]

Eu apenas traduzi meu artigo no Medium :v.

Código de exemplo: Github

Um tempo atrás (cerca de seis meses) eu comecei a desenvolver em Javascript. Com focus na engine, RPG Maker MV (e criação de coisas para website), na qual eu gosto de criar coisas. Então com a prática e minhas experiências anteriores com Ruby e C#, eu fiquei confiante na programação.

Mas uma coisa que sempre me persegue é o design do código. Eu não sei se é porque eu sou designer gráfico ou coisa assim, mas eu gosto de fazer códigos com aspecto estético para mim e para outras pessoas. Então irei mostrar a você, querida pessoa, meu modo de fazer códigos estéticos e legíveis em Javascript.

Sumário do meu modo de fazer:
• Use JSDoc para seção de comentários e descrições de métodos.
• Crie no começo do código, uma introdução
• Crie chaves para localizar partes do código


Parte da introdução: Veja abaixo na imagem o exemplo
Nota: Eu recomendo definir limite de caracteres baseado na linha de espaço (=====================================)​



Parte de localização: Nessa parte você irá definir um bloco de comentários onde você irá por chaves para localização.
Atenção: Você precisa escrever o 'symbol name' na parte onde estará o código. Veja abaixo
Nota: Você pode escrever códigos antes da parte de localização, mas eu recomendo somente códigos pequenos



Por que? pois quando é estruturado e tem uma boa estética, irá melhorar o seu tempo de leitura e edição, depois de um tempo. E  o mais importante, quem ler o seu código terá orgasmos hehe

[Opalablue]

Eu sinceramente faço isso com todos os meus códigos da aula de python, porque eu gosto de ter tudo organizado.
Tenho uma memória fraca, portanto, ao fazer isso, apenas uma rápida leitura vai me fazer lembrar do que se tratava o código em questão, ou do raciocínio que eu usei para o mesmo.
Não só isso, mas tem aquela coisa: você prefere estudar numa escrivaninha, com post its e materiais separados todos direitinhos, ou na mesa de jantar da sua família, com todo mundo comendo, discutindo, e pouca luz? Ou seja, prefere estudar/trabalhar com um código limpo e organizado, ou um código todo sem pé nem cabeça? Eu até erro menos quando tenho tudo mais claro.

Detesto quando pego um código, pro próprio rpg maker, e ele está todo desorganizado. Nem um simples cabeçalho o autor as vezes faz.

Sejam como o Kvothe e arrumem seus códigos