curso de inverno - boas práticas de programação.pptx

7/24/2019 Curso de Inverno - Boas Prticas de Programao.pptx

1/48

1

Boas prticas de programaoCDSP - 18/07/2011


2/48

2

Boas prticas de programao

I) Escrevendo o Cdigo Fonte Estrutura do cdigo fonte Legibilidade Letras maisculas Capitulao de palavras chave Notao ngara ComentriosII) Visibilidde e !o"enclt#rIII) Prote$%o de &otinsIV) Dese"'en(oV) Dics

!DICE


3/48

*re de cbe$l(o


+

Estr#t#r do Cdigo

Fonte

Nessa rea so declarados os ar!uivos de include"variveis estticas e as constantes#


4/48

*re de identi,c$%o


Estr#t#r do Cdigo

Fonte

Nessa rea deve$se documentar o programa oufuno# Cont%m comentrios e&plicando a sua'nalidade" data de criao" par(metros" retornos ealtera)es efetuados#


5/48

*re de declr$%o de vri.veis e #stesiniciis


Nesta rea devem ser feitos os a*ustes iniciais"importantes para o correto funcionamento doprograma# Entre esses a*ustes iniciais encontram$se a declarao e iniciali+ao de varveis"

abertura de ar!uivos" etc#

Estr#t#r do Cdigo

Fonte


6/48

Cor'o do 'rogr"


, o cdigo escrito para reali+ar a tarefa necessriapara atingir o seu ob*etivo#

Estr#t#r do Cdigo

Fonte


7/48

*re de encerr"ento


7

Nessa rea 'nali+amos a e&ecuo da rotinafechando reas de trabalho temporrias" limpando'ltros" restaurando reas salvas e retornamos o

resultado da rotina#

Estr#t#r do Cdigo

Fonte


8/48


8

egibilidde 3 Ident$%o

do cdigo

Cdigo identado

Cdigo no identado

-dentar o cdigo torna mais fcil identi'car blocos decomandos !ue faam parte de um loop ou estruturacondicional#


9/48


4

egibilidde - 5#ebr de

lin(sLinhas muito longas podem di'cultar a legibilidade"nesses casos % melhor !uebrar a linha usando o pontoe v.rgula#

/em !uebra de linha

Com !uebra de linha


10/48


10

egibilidde - Es'$os e"

brnco-nserir espaos torna mais fcil identi'car par(metrosde uma funo" distinguir as chaves em uma busca ouvisuali+ar os itens de um clculo#


11/48


11

etrs 6isc#ls

E&istem alguns casos em !ue o cdigo deve ser escritoem letras maisculas#

Cdigo /0L /ELEC1 2 3456 /N7889

Nome de campos /N7$:N7;CB;CB


12/48


12

C'it#l$%o de 'lvrs

c(veDma conveno amplamente utili+ada % a de capitularas palavras chaves" fun)es" variveis e camposutili+ando uma combinao de caracteres emmaisculo e minsculo" visando facilitar a leitura docdigo fonte#


13/48


1+

!ot$%o ngr

@eve ser utili+ada para identi'car o tipo de contedode uma varivel#


14/48


1

Co"ent.rios

Comentrios servem como documentao e e&plicaode um cdigo fonte" mantendo um histrico efacilitando seu entendimento para anlise emanuteno#

Comentar o fonte" facilita o entendimento por parte doanalista !ue precisar reali+ar manuteno e at%mesmo para !uem o criou" mas lembre$se !ue

comentrio em e&cesso polui o cdigo e podeatrapalhar" portanto use o bom senso#

No e&iste uma regra sobre o !ue se deve comentar ou

como" mas segue algumas dicas sobre o !ue comentare melhorar o entendimento do seu cdi o fonte#


15/48


1

Co"ent.rios

-nsira um cabealho e comente !ual 'nalidade da rotinaou funo" descrevendo !uais par(metros devem serpassados e !ual deve ser o retorno esperado#

Comente a chave do .ndice utili+ado ao lado da funodb/et5rderF

0uando utili+ar strings de um ar!uivo C" insira um

comentrio ao lado com o te&to da string#

Comente clculos" e&plicando !ual sua lgica#

Comente trechos de cdigo" e&plicando de forma sucintasua 'nalidade#


16/481


I) Escrevendo o Cdigo FonteII) Visibilidde e !o"enclt#r

Aadro de Nomenclatura =isibilidade

III) Prote$%o de &otinsIV) Dese"'en(oV) Dics

!DICE


17/48

Cdigo Fonte

5 nome do cdigo$fonte deve ser montado da seguinteformaG

F"9lis de Progr"s : ;i'o de


18/48


18

Pdr%o de !o"enclt#r

EBe"'lo de no"e de Cdigo Fonte

-ncluso de dados do mdulo Jesto de Aessoas $:PE010>P&

;rec(o Descri$%o

JAE 3am.lia de programas do mdulo Jesto de Aessoas#

< Entrada de dados#

979 Numerao de fonte dispon.vel#

#A4K E&tenso indicadora de !ue o ar!uivo % um cdigo$fonte


19/48


14

Pdr%o de !o"enclt#r

F#n$es


20/48


20

Pdr%o de !o"enclt#r

EBe"'lo de no"e de F#n$%o

3uno de incluso de dados no 3-N


21/48

EBe"'losG

=alidaCpoF $: =alida contedo de campo

CalcMurosF $: Clculo de *uros


21

Pdr%o de !o"enclt#r

Aara fun)es gen%ricas utili+adas em um determinadomdulo" nomeia$se a funo diretamente de acordo com asua aplicabilidade#


22/48

EBe"'losG

cCodigo =arivel caractere para arma+enar umcdigo

cN3 =arivel caractere com o nmero da Nota 3iscalnCount =arivel num%rica usada como contadorc6oeda =arivel caractere com o cdigo da moeda


22

Pdr%o de !o"enclt#r

Aara variveis no e&iste um padro" por%m deve$se utili+arum nome de acordo com a sua 'nalidade" facilitando oentendimento#


23/48


2+

Pdr%o de !o"enclt#r

No existe tamanho mximo para nomes de variveis e funes,

entretanto o compilador reconhece apenas 10 caracteres, ignorando o

restante.

As variveis nalor!itulo"agar e nalor!itulo#ece$er, so vistas pelocompilador como nalor!itu


24/48


2

Visibilidde

F#n$es

3un)es sem declarao !uando usadas a partir do menuda aplicaoF" declaradas como 6ain ou Dser so vis.veisem todo o sistema" carregando a pilha de memria"portanto se forem usadas apenas no prprio cdigo fontedevem ser declaradas como /1


25/48


2

Visibilidde

Vri.veis


26/482


I) Escrevendo o Cdigo FonteII) Visibilidde e !o"enclt#rIII) Prote$%o de &otins

Campos" 3un)es e 1abelas -niciali+ao de variveis


27/48


27

Prote$%o 3 C"'osH ;bels e

F#n$es

Nos fontes do padro % muito importante veri'car ae&istOncia de campos" tabelas e fun)es# Essa precauoevita erros nas rotinas !uando so utili+adas em sistemasdesatuali+ados#

3ieldAos =eri'ca a e&istOncia de um campo" evitando !ue arotina tente manipular campos ine&istentes# 4etorna posio

num%rica do campo#


28/48


28

Prote$%o 3 C"'osH ;bels e

F#n$esExemplos:


29/48


24

Prote$%o 3 IniciliA$%o de

Vri.veis


30/48


+0

Prote$%o 3 lis tivo

Dma proteo muito importante em todas as fun)es %salvar o conte&to do alias ativo e tamb%m da!uelesmanipulados dentro da sua funo#Essa proteo garante !ue sua funo no interferir na

e&ecuo da funo chamadora# < funo Jet


31/48


+1

Prote$%o 3 ;rt"ento de retorno

de #n$es

0uando chamar fun)es com algum retorno" utili+e umaestrutura condicional para veri'car seu retorno#

i d


32/48


+2

Prote$%o 3 Es'eci,cr o lis


33/48


++

Prote$%o 3 Controle de ;rns$%o


34/48


+

Prote$%o 3 Controle de ;rns$%o

EBe"'loG

/e alguma rotina degravao no for e&ecutadacorretamente" as anteriores

sero desfeitas

B ti d


35/48


+

Prote$%o 3 ocliA$%o

0uando a e&ecuo de parte do cdigo estiver condicionadaa uma determinada locali+ao deve$se testar o contedoda varivel global cAaisLoc#

B ti d


36/48


+

Sigl P9s

! ngol

& rgentin

J


37/48


+7

Prote$%o 3 Jnco de Ddos

No


38/48


+8

Prote$%o 3 Jnco de Ddos

B ti d


39/48

+4


I) Escrevendo o Cdigo FonteII) Visibilidde e !o"enclt#rIII) Prote$%o de &otinsIV)Dese"'en(o

Comparativo entre fun)esV) Dics

!DICE



40/48


0

Dese"'en(o 3 Co"'rtivo entre

F#n$es

Comparativo entre algumas fun)es !ue podem sersubstitu.das por outras similares !ue melhoram odesempenho da rotina#



41/48


1


F#n$es6sSeeNO) Vers#s dbSeeNO)

6s/eeQF possui as mesmas funcionalidades bsicas dafuno @b/eeQF" com a vantagem de no necessitar

acessar novamente a base de dados para locali+ar umainformao * utili+ada pela thread cone&oF ativa#@esta forma" a thread mant%m em memria os dadosnecessrios para reposicionar os registros * locali+adosatrav%s do comando @b/eeQ no caso o 4ecnoFF de forma!ue a aplicao pode simplesmente efetuar oposicionamento sem e&ecutar novamente a busca#< diferena entre o @b/eeQF e o 6s/eeQF % notada emaplica)es com grande volume de posicionamentos" como

relatrios" !ue necessitam referenciar diversas ve+es omesmo registro durante uma e&ecuo#



42/48


2


F#n$eset6VO) Vers#s et!e?PrO) Vers#s S#'eret6VO)

Jet6=F retorna o contedo de um par(metro e se ele noe&istir o seu retorno depender dos par(metros lelp e

&@efault# /e &@efault for informado o retorno" caso noe&ista" ser &@efault e se no informado retorna #3# e e&ibeelp para lelp falso#/uperJet6=F diferencia$se por arma+enar em um arraP ospar(metros consultados" mas caso se*a a primeira consultaao par(metro" aciona a funo Jet6=F#JetNeRAarF simplesmente aciona a rotina /uperJet6=F#



43/48


+


F#n$esPosicioneO) Vers#s etDVFVlO)

< funo A5/-C-5NEF permite o retorno do contedo de umcampo de um registro de uma tabela especi'cado atrav%s

de uma chave de busca en!uanto !ue o Jet


44/48


I) Escrevendo o Cdigo FonteII) Visibilidde e !o"enclt#rIII) Prote$%o de &otinsIV)Dese"'en(oV) Dics

@icas teis

!DICE



45/48


Dics 3 lg#"s dics teis

5perador STTS no % o mesmo !ue STS# Embora ocompilador no acuse erro" o resultado da comparao noser o mesmo# Espaos em branco fa+em diferena na

comparao" utili+e


46/48


Dics 3 lg#"s dics teis

Em Loops condicionados ao 'm de uma tabela noes!uea de fa+er um /Qip" preferencialmente usando oalias E /NL$:db/QipFF F# /e houver uma condio

dentro do Khile" veri'!ue se o /Qip ser e&ecutado#

/empre !ue poss.vel utili+e a passagem de par(metros porreferOncia no lugar de variveis tipo Arivate#



47/48


7

Fonte de Cons#lt


48/48

@anilo @ias

danilo#diasVtotvs#com#br

5@ES;ES

mailto:[email protected]:[email protected]

curso de inverno - boas práticas de programação.pptx

Documents