#2 - Aula de Scripting Lua - indentação e comentários

[Poccnn 385]

                       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.
    

 

Citar

function 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.
 

Editado Maio 5, 2017 por Poccnn

[Silveira Crtba 2]

-----Construção de algo-----

 

>Adquirir planta do projeto       ---(mapa de área com medidas)---

>Confirmar se o terreno está apto a construção   ---(se o terreno tem suporte para está construção)---

>Obter operários   ---(Procurar trabalhadores para ajudarem na obra)---

   >Confirmar os valores de seus serviços    ---(Obter a informação de quanto cada operário vai solicitar como pagamento)---

>Armazenar recursos para o projeto   ---(Comprar materiais para a construção)---

   >Conferir armazenamento de materiais   ---(Verificar se não falta material algum para dar início a obra)---

>Requisitar equipamento de segurança para todos    ---(Solicitar que todos tenham seus devidos equipamentos de segurança)---

   >o Projeto não começa antes disso   ---(Se tudo não estiver conforme desde o 1° passo até o 7° a construção não começará)---

>Dar início a obra   ---(Dar ordem para iniciar a construção)---

   >Medir e erguer as paredes   ---(Calcular a área de cada parede e sua medida para melhor uso, tanto do local quanto do material)---

   >nivelar o piso  ---(Medir o nível do piso para que o mesmo não seja terminado fora de suas medidas!)---

   >erguer forro   ---(Erguer o forro sobre as paredes)---

   >Construir telhado   ---(Acima do forro, construir telhado)---

   >Passar canos pelo solo  ---(Passar cada cano de água e esgoto pelo solo e instalar cada um eles em seu devido local)---

   >Executar instalação de cabos de energia   ---(Puxar cabos de luz do poste, passar pelo solo até o local da obra, instala-los em seus respectivos lugares)---

   >Finalizar e entregar a obra   ---(Realizar acabamentos e entregar a obra ao comprador)---

>Pagar operários   ---(Entregar o pagamento de cada operário conforme o combinado conforme o 4º Passo)---

[Poccnn 385]

Uma coisa que se faz necessário saber é que: tu não precisa por comentários em cada passo do código; somente nos mais necessários estará bom.

O código, quanto mais simples, com menos conteúdo, será melhor.

 

[Silveira Crtba 2]

10 horas atrás, Poccnn disse:

Uma coisa que se faz necessário saber é que: tu não precisa por comentários em cada passo do código; somente nos mais necessários estará bom.

O código, quanto mais simples, com menos conteúdo, será melhor.

 

etendi me desculpe, vou refazer ^^

-----Construção de algo-----  2° Tentativa

 

>Adquirir planta do projeto       ---(mapa de área com medidas)---

>Confirmar se o terreno está apto a construção

>Obter operários

   >Confirmar os valores de seus serviços    ---(Obter a informação de quanto cada operário vai solicitar como pagamento)---

>Armazenar recursos para o projeto

   >Conferir armazenamento de materiais

>Requisitar equipamento de segurança para todos

   >o Projeto não começa antes disso   ---(Se tudo não estiver conforme desde o 1° passo até o 7° a construção não começará)---

>Dar início a obra

   >Medir e erguer as paredes   ---(Calcular a área de cada parede e sua medida para melhor uso, tanto do local quanto do material)---

   >nivelar o piso

   >erguer forro

   >Construir telhado

   >Passar canos pelo solo  ---(Passar cada cano de água e esgoto pelo solo e instalar cada um eles em seu devido local)---

   >Executar instalação de cabos de energia   ---(Puxar cabos de luz do poste, passar pelo solo até o local da obra, instala-los em seus respectivos lugares)---

   >Finalizar e entregar a obra

>Pagar operários   ---(Entregar o pagamento de cada operário conforme o combinado conforme o 4º Passo)---

[Nildson 2]

- Lavar as mãos na casa do amigo ( Mãe do meu amigo pediu para que eu lava-se minhas mãos para lanchar)

Bom queria tentar fazer dessa forma

 

-- NPC = Mãe do amigo

-- NPC = Amigo                

-- ITEM = Sabão

-- Função do item = "ensaboa as mãos n pia"

-- Localização [x,y,z] = Pia

-- Terminou a conversar com amigo = Ganha x storage 

-- Usou o sabão na pia para lavar as mãos = Ganha y storage

-- Eu = Eu

-- Item ganho no final da quest = Vasilha de Pipoca

 

> Eu : hi

> Mãe do amigo : Vá ao banheiro lavar as suas mãos que irei trazer pipoca {sim} ?

  > Eu : sim

> Mãe do amigo : Pergunte ao Amigo onde você irá encontrar a pia, boa sorte!

 

> Eu : hi

> Amigo : Oi, minha mãe pediu para você {lavar} as mãos ?
  > Eu : lavar

> Amigo : Certo , o caminho para você chegar ao banheiro é só virar a direita, lá você vai encontrar a pia [x = 151 , y = 159 , z = 7] e utilize este {sabão} que estou lhe dando.
  > Eu : sabão
Texto : " Você pegou sabão " (Ganhou Storage x )
> Vá até a pia e lave ! 

> Fui até a pia 
> Abrir torneira
  > "Retorne para abrir a pia só quando pegar o sabão com seu amigo!" (Storage x )

> Molhar a mão

> Utilizar sabão na pia 

Texto " Você ensaboou suas mãos, agora termine de lavar e volte a conversar com seu amigo " (Ganhou Storage y )

> Desligar a pia e voltar a conversar com amigo

 

> Eu : hi

> Amigo : Oi , minha mãe pediu para você {lavar} as mãos ?

  Eu : lavar

> Amigo : Nossa você conseguiu lavar suas mãos, minha mãe trouxe duas vasilhas de pipoca para nós dois come-las.

Texto : " Você acaba de receber Vasilha de pipoca "

FIM

Espero que dê certo, caso tenha coisas erradas pode falar professor

Editado Abril 7, 2017 por Nildson

[Poccnn 385]

13 horas atrás, andrewbonisil disse:

etendi me desculpe, vou refazer ^^

-----Construção de algo-----  2° Tentativa

 

>Adquirir planta do projeto       ---(mapa de área com medidas)---

>Confirmar se o terreno está apto a construção

>Obter operários

   >Confirmar os valores de seus serviços    ---(Obter a informação de quanto cada operário vai solicitar como pagamento)---

>Armazenar recursos para o projeto

   >Conferir armazenamento de materiais

>Requisitar equipamento de segurança para todos

   >o Projeto não começa antes disso   ---(Se tudo não estiver conforme desde o 1° passo até o 7° a construção não começará)---

>Dar início a obra

   >Medir e erguer as paredes   ---(Calcular a área de cada parede e sua medida para melhor uso, tanto do local quanto do material)---

   >nivelar o piso

   >erguer forro

   >Construir telhado

   >Passar canos pelo solo  ---(Passar cada cano de água e esgoto pelo solo e instalar cada um eles em seu devido local)---

   >Executar instalação de cabos de energia   ---(Puxar cabos de luz do poste, passar pelo solo até o local da obra, instala-los em seus respectivos lugares)---

   >Finalizar e entregar a obra

>Pagar operários   ---(Entregar o pagamento de cada operário conforme o combinado conforme o 4º Passo)---

Muito bom. Alguns pontos qje precisavam de uma informação a mais foram clarificadas. Esse é o objetivo dos comentários nos códigos. 

 

11 horas atrás, Nildson disse:

- Lavar as mãos na casa do amigo ( Mãe do meu amigo pediu para que eu lava-se minhas mãos para lanchar)

Bom queria tentar fazer dessa forma

 

-- NPC = Mãe do amigo

-- NPC = Amigo                

-- ITEM = Sabão

-- Função do item = "ensaboa as mãos n pia"

-- Localização [x,y,z] = Pia

-- Terminou a conversar com amigo = Ganha x storage 

-- Usou o sabão na pia para lavar as mãos = Ganha y storage

-- Eu = Eu

-- Item ganho no final da quest = Vasilha de Pipoca

 

> Eu : hi

> Mãe do amigo : Vá ao banheiro lavar as suas mãos que irei trazer pipoca {sim} ?

  > Eu : sim

> Mãe do amigo : Pergunte ao Amigo onde você irá encontrar a pia, boa sorte!

 

> Eu : hi

> Amigo : Oi, minha mãe pediu para você {lavar} as mãos ?

  > Eu : lavar

> Amigo : Certo , o caminho para você chegar ao banheiro é só virar a direita, lá você vai encontrar a pia [x = 151 , y = 159 , z = 7] e utilize este {sabão} que estou lhe dando.

  > Eu : sabão

Texto : " Você pegou sabão " (Ganhou Storage x )

> Vá até a pia e lave ! 

 

> Fui até a pia 

> Abrir torneira

  > "Retorne para abrir a pia só quando pegar o sabão com seu amigo!" (Storage x )

> Molhar a mão

> Utilizar sabão na pia 

Texto " Você ensaboou suas mãos, agora termine de lavar e volte a conversar com seu amigo " (Ganhou Storage y )

> Desligar a pia e voltar a conversar com amigo

 

> Eu : hi

> Amigo : Oi , minha mãe pediu para você {lavar} as mãos ?

  Eu : lavar

> Amigo : Nossa você conseguiu lavar suas mãos, minha mãe trouxe duas vasilhas de pipoca para nós dois come-las.

Texto : " Você acaba de receber Vasilha de pipoca "

 

FIM

Espero que dê certo, caso tenha coisas erradas pode falar professor

Estás bem adiantado. 

Isso como tu fez só será tratado na aula de variáveis. 

Mas ficou bom e sua metodologia é bem qualificada.

 

[Nildson 2]

39 minutos atrás, Poccnn disse:

Estás bem adiantado. 

Isso como tu fez só será tratado na aula de variáveis. 

Mas ficou bom e sua metodologia é bem qualificada.

 

Bom primeiramente obrigado, essa é a consequência de ficar copiando scripts no fórum,eu tento ler de onde ta vindo o item, storage essas coisas e estou muito feliz por estar participando de suas aulas e quero aprender mais e mais!!!

[Silveira Crtba 2]

15 horas atrás, Poccnn disse:

Muito bom. Alguns pontos qje precisavam de uma informação a mais foram clarificadas. Esse é o objetivo dos comentários nos códigos. 

 

Estás bem adiantado. 

Isso como tu fez só será tratado na aula de variáveis. 

Mas ficou bom e sua metodologia é bem qualificada.

 

Po valeu, me animou kkk, obrigado e que venha a aula 3 ^^

Editado Abril 8, 2017 por andrewbonisil

[ZoR 8]

Em 06/04/2017 at 08:22, Poccnn disse:

Uma coisa que se faz necessário saber é que: tu não precisa por comentários em cada passo do código; somente nos mais necessários estará bom.

O código, quanto mais simples, com menos conteúdo, será melhor.

 

>> Pegar Material para fazer a planta>>Ver Quanto sao a Equip --- (aqui voçe coloca a quantidade de player que ira trabalhar)>>Ver se eles possuem o Material certo ---- (Id do item que vc quer para eles construirem)>>colocar o equipamento certo ---- (nao mexa)>>se faltou 1 cancelar ----- (nao mexa)>>começar a construir>>Finalizar

acho q ta certo

Editado Abril 8, 2017 por ZikaLord

[PuW 4]

-----ESTOQUE
> Fazer um estoque com todos os matérias necessários para a construção.

> Checar se tem material necessário, se não fazer pedido do material e parar obra até que chegue.

> Pegar material no estoque.

> Seguir para planta.
-----PLANTA

> Obter planta para construção.

> Se não tiver, parar á obra até ter a planta.

> Seguir para equipe.

-----EQUIPE

> Obter Equipe.
> Se não tiver, parar á obra até ter a equipe.

> Seguir para segurança.

 -----SEGURANÇA
> Toda Equipe usar equipamentos de segurança.

> Não está, parar a obra até que todos coloquem. 

> Verificar Equipamento de Segurança.
> Não está, parar a obra até que todos coloquem.

> Seguir para terreno.

-----TERRENO

> Preparar terreno. -- começo da obra.
> Se não preparar, parar á obra até que preparem.

> Seguir para construção.

-----CONSTRUÇÃO

> Verificar passos dois e três. -- verificação dos matérias e condições da obra.
> Montar Alicerce.

> Verificar passos dois e três. 
> Erguer Paredes.

> Verificar passos dois e três.
> Erguer Tetos.

> Verificar passos dois e três. 
> Colocar Pisos.

> Verificar passos dois e três.

> Finalizar Acabamento Interior e Exterior.

-----FINALIZAÇÃO

> Checar estágio da obra.

> Se não finalizada, voltar ao 4 passo e recomeçar.

> Se finalizada, entregar a construção. --fim de obra

[Poccnn 385]

Ficou muito bom e bem divido em setores.

A terceira aula já foi postada. Espero que gostem.

[macacaue 3]

 

Não sei se entendi direito...

Mais era só pra add comentário? >.<

 

Plano ~~> -- Todos os RequisitosVerificar se há uma planta > Se não Tiver fazer> Verificar o tamanho da equipe > Se tiver dividir os trabalhos> Verificar se tem o Material Nescessario > Se não Tiver, CompreExecução ~~> -- Aqui São todos os passos para se fazer>Faça 1 furo na parte superior da madeira>Faça 1 furo na parte inferior da madeira>Faça em todas as madeira que for utilizar> Cave um buraco com 500cm pra baixo para cada madeira, com espaço de 1m cada um>Coloque as madeiras fixadas no chão>Feche o Buraco para fixar mais ainda a madeira>Passe arame no meio do buraco de todas as cercas>Por fim estique o arame para não ficar froxo

 

 

 

[Poccnn 385]

Sim.

Os comentários são importantes em qualquer script para facilitar o entendimento do mesmo.