indentação e comentários
Link da aula anterior, caso tu não tenha lido ela.
Para que o código fique bonito, organizado e de fácil entendimento; usamos de indentação e comentários que nos ajudam e ajuda aos demais programadores, a saber, de forma fácil do que se trata cada código.
Um código sem indentação se torna de difícil leitura além de dar margem aos erros de escrita do código.
Citarfunction saveQuestsInfor(uid,name,cid,other) if not(db.executeQuery("SELECT * FROM `server_quests`;"))then
db.executeQuery("CREATE TABLE `server_quests` (`uid` INTEGER, `name` VARCHAR(255), `name_player` VARCHAR(255), `pos` VARCHAR(255), `other` TEXT);") end
local other,pos2,pos = other or '','',nil, type(uid) == 'number' and getThingPos(uid) or getCreaturePosition(cid)
pos2 = 'x='..pos.x..', y='..pos.y..', z='..pos.z
if not(type(name) == 'string') or not(tonumber(cid))then return false, print('Funcao requer parametros: name,cid') end db.executeQuery("INSERT INTO `server_quests` (`uid`, `name`, `name_player`,`pos`,`other`) VALUES ("..(uid or tonumber(pos.x..''..pos.y..''..pos.z))..",'"..name.."', '"..getCreatureName(cid).."','"..pos2.."','"..other.."');") return true
end
Esse código demonstra como é difícil entendê-lo. Não se sabe bem onde inicia um bloco ou onde ele termina; não tem comentários para ajudar, a saber, do que se trata ou o que cada coisa faz. Vejamos o mesmo código com indentação e comentários.
Obs: Será usada a forma de comentários usada na linguagem de programação lua.
Tudo isso ajuda quando escrevemos um código; torna o código mais legível, de fácil entendimento e qualquer outro programador que queira dar continuidade ao código ou modifica-lo, saberá de uma forma fácil o que cada coisa faz. Essa é uma boa pratica em programação. Qualquer pessoa que queira ser programador, primeiro tem que saber como escrever um código e torna-lo claro e de fácil leitura.
Uma pratica em programação é quando estamos criando longos códigos é não conseguimos termina-los, deixamos escrito no código o que ficou para ser terminado ou, no caso se estivermos testando o script, onde ocorreu o erro, que tipo de erro sucedeu, qual a localização da função, método onde ocorreu o erro e etc.
Agora insiram no código criado por vocês na aula anterior uma boa indentação e comentários para que se tornem legíveis e de fácil entendimento.
