Algo que eu não dava muita importância nos tempos de projetos para o colégio, é a organização de código, de modo que o código fique mais legível, simples e sem necessidade de muitos comentários.
Por exemplo, o códgio abaixo:
conditions = Sql::Conditions.new
if (value = params.get(:section_id)) then conditions.and('videos.section_id = ?', value) end
if (value = params.get(:source_id)) then conditions.and('videos.source_id = ?', value) end
if (value = params.get(:category_id)) then conditions.and('collectible_data.category_id = ?', value) end
if (value = params.get(:source)) then conditions.and('video_sources.name = ?', value) end
Poderia ser escrito dessa forma:
conditions = Sql::Conditions.new
if (value = params.get(:section_id)) then conditions.and('videos.section_id = ?', value) end
if (value = params.get(:source_id)) then conditions.and('videos.source_id = ?', value) end
if (value = params.get(:category_id)) then conditions.and('collectible_data.category_id = ?', value) end
if (value = params.get(:source)) then conditions.and('video_sources.name = ?', value) end
Qual você acha mais legível? Qual você consegue entender mais rápido?
Você pode reparar que a diferença não tem nada a ver com a sintaxe nesse caso, e sim com espaçamento e identação do código.
Pode não parecer muita coisa olhando somente para esse trecho de código, mas você não acredita o que alguns espaços em branco, pulos de linha e caracteres separadores podem fazer!
Mas de que adianta fazer tudo organizado, de modo legível se outra pessoa de sua equipe escrever de um modo completamente desorganizado ou simplesmente diferente?
Para isso, antes de começar um projeto, ou até mesmo uma equipe, é necessário definir um padrão de código que todos concordem e gostem. Dessa forma você vai conseguir entender o projeto inteiro de uma forma mais rápida e sem depender que o autor da implementação lhe explique o porquê de ter feito aquilo daquela forma.
Claro que não podemos deixar de escrever comentários em alguns casos, mas é preferível que se faça um código que seja possível entender simplesmente lendo o código em sí, com nomes de variáveis e de métodos apropriados.
