Procedimento Operacional

Assunto Vigência Documento

Regras de Codificação de Sistemas

01.11.2008
Versão

PO.01
Página

1.0

1 / 26

SUMÁRIO
7. ESTRUTURA DE CLASSES.................................................................................................................................................14 8. ESTRUTURA DE FORMULÁRIOS....................................................................................................................................15 11. CONCLUSÃO.......................................................................................................................................................................25

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

'onald Vi&en(anda # )erente de *+

Procedimento Operacional
Assunto Vigência Documento

Regras de Codificação de Sistemas
1. OBJETI O

01.11.2008
Versão

PO.01
Página

1.0

2 / 26

, ob-eti&o %rinci%al deste manual de %rocedimento o%eracional . normali/ar a codi0ica1ão de sistemas desen&ol&idos internamente %ela 2nidade de )estão de *ecnologia de +n0orma1ão. Atra&.s desta %adroni/a1ão3 todos os sistemas terão "ue seguir 0ielmente as regras estabelecidas neste manual. !. "P#IC"$%O A a%lica1ão deste manual será a%enas %ara os sistemas "ue serão desen&ol&idos utili/ando a linguagem Del%4i. omo se trata de um manual interno o%eracional da unidade de *+3 isso im%lica "ue todos os %rogramadores Del%4i de&erão a%licar este %adrão em "ual"uer sistema. &. RESPO'S"BI#I("(ES abe a 2nidade de )estão de *ecnologia de +n0orma1ão de0inir "uais são as regras &iá&eis %ara a codi0ica1ão3 e tamb.m acom%an4ar se o desen&ol&imento do sistemas estão sendo ade"uados con0orme a %adroni/a1ão. ). (E*I'I$+ES ,ER"IS 5este manual tamb.m será in0ormado a %adroni/a1ão dos ob-etos criados no banco de dados3 com isso3 . %oss6&el ter uma organi/a1ão 4omogênea de todos sistema elaborado %ela unidade de *+. -. 'OME'C#"TUR" , "ue . um identi0icador7 2m identi0icador de &ariá&el ou 0un1ão rotula uma entidade e &eicula in0orma18es sobre seu %ro%9sito. 2m identi0icador de&e ser in0ormati&o3 conciso3 memoriá&el3 %adroni/ado e3 se %oss6&el3 %ronunciá&el. )rande %arte das in0orma18es &em do conte:to e do esco%o. ;uanto mais am%lo 0or o esco%o de uma &ariá&el3 mais in0orma18es de&em ser &eiculadas %or seu identi0icador. 5ão 4á restri1ão %ara o em%rego de identi0icadores gra0ados em inglês <como &iValue= ou %ortuguês <&iValor=3 contudo a escol4a de&e ser coerente em todo c9digo>0onte escrito.

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

'onald Vi&en(anda # )erente de *+

+- I im%ortante obser&ar "ue no momento da sele1ão do nome da constante . Estes %re0i:os serão ane:ados muitas &e/es aos %re0i:os básicos da nota1ão !Cngara. Por con&eniência3 um %re0i:o %ode ser utili/ado Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .1 P'EA+B.m disso3 um G cH. * +.0 ? / 26 .? VA'+JVE+$ A cria1ão de nomes de &ariá&eis Cteis %ode ser um desa0io. *ais constantes são escritas em letras maiCsculas %ara serem di0erenciadas dos nomes de &ariá&eis. .Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas @. Fas na nomenclatura a"ui de0inida &amos utili/ar3 al. 5ela3 os nomes de &ariá&eis são criados colocando um %re0i:o curto diante de um nome mais longo e descriti&o. 4arles $imonMi13 ocu%a uma %osi1ão intermediária entre os dois e:tremos. 5o lugar destes nCmeros de&erão ser utili/adas constantes simb9licas. 5omes curtos de &ariá&eis são tentadores3 %ois são 0áceis de digitar3 mas %odem tornar o c9digo di06cil de ser entendido. A nota1ão !Cngara <!ungarian 5otation=3 criada na Ficroso0t %elo Dr. recomendá&el escol4er um identi0icador "ue e:%resse sua 0inalidade.+cSENSI I!I"#"E$!EI%&'#(.m descre&e a 0orma "ue uma &ariá&el .'*'A53 KA$+ 3 .11.2 .L ou li%%er saberá do "ue se trata.K. . . uma &ariá&el3 uma constante3 um ar"ui&o ou outros. utili/ada. @. ob-eti&o dos %re0i:os . De&em estar em letra minCscula3 no in6cio do identi0icador3 e são os seguintesD fc – Identifica uma função pc – Identifica um procedimento c – Identifica uma constante v – Identifica uma variável u – Identifica uma unidade ou módulo (opcionalmente pode-se utilizar o prefixo m) @. Em "ual"uer linguagem de %rograma1ão3 as constantes simb9licas mel4oram a legibilidade de um %rograma e tornam sua manuten1ão mais 0ácil.5$*A5*E$ Em geral3 .01 Página 1. %re0i:o descre&e o ti%o de dado re0erenciado %ela &ariá&el. Em alguns casos3 um %re0i:o tamb. +sto torna seu c9digo di06cil de ser conte:tuali/ado. $e algu. Em contra%artida os nomes longos de &ariá&eis %odem tornar o c9digo mais leg6&el3 mas sobrecarregam o %rogramador "ue irá digitá>los.m tentar ler um c9digo em A.m aumenta as c4ances de algum nome ser digitado incorretamente. taman4o do nome de&e ser intermediário3 ou se-a3 não muito curto e nem muito longo3 mas o su0iciente %ara e:%ressar o signi0icado de sua e:istência. e:em%lo abai:o mostra algumas constantes simb9licasD const cSENSI I!I"#"E$!EI%&'#() * +.2008 Versão PO.'E$ 01. * +/+cSENSI I!I"#"E$!EI%&'#(. uma %rática não muito 0eli/ colocar nCmeros tal como 1@ ou E00 em um %rograma3 os c4amados nCmeros mágicos. A utili/a1ão de nomes longos tamb. na &erdade 0ornecer ao %rogramador uma 0orma de identi0icar "ue ti%o de elementos ele está mani%ulando3 se .$ +5D+ AD. Em &e/ de %rocurar em uma %il4a de c9digo 0onte "uando os &alores num.ricos são alterados3 a%enas uma lin4a de c9digo "ue de0ine o &alor de&e ser atuali/ada.

0 E / 26 isoladamente como um nome de &ariá&el.$ A cria1ão de nomes de &ariá&eis Cteis %ode ser um desa0io. Em .b-ect PascalD var vc7 . +sto signi0ica "ue eles são Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . c7arvsName .K.'*'A53 KA$+ 3 .E L+$*A DE P'EA+B. Em contra%artida os nomes longos de &ariá&eis %odem tornar o c9digo mais leg6&el3 mas sobrecarregam o %rogramador "ue irá digitá>los. 5esta nomenclatura estendida3 serão ane:ados tais %re0i:os a%9s o identi0icador de elemento <%ara &ariá&eis o &=. strin0- @.m tentar ler um c9digo em A.01 Página 1. Prefixo 0 i s 3 r d f t dt a c3 c7 f i9 ix I Ip I9 Tipo de Dados 1ariável 2lo3al (antes do tipo) Inteiro Strin0 oolean 'eal "ata 4loat %ime "ate%ime #rra5 (tipo composto) 6onta0em de 5tes 6aracter 8onto 4lutuante Inteiro sem sinal :ndice (composto) Inteiro lon0o 8onteiro lon0o (tipo composto) !on0 sem Sinal sp s l 9 p 8onteiro curto (tipo composto) Convenções S7ort !on0 Sem sinal 8onteiro .2008 Versão PO.m aumenta as c4ances de algum nome ser digitado incorretamente.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01. A utili/a1ão de nomes longos tamb.L ou li%%er saberá do "ue se trata.11. 5omes curtos de &ariá&eis são tentadores3 %ois são 0áceis de digitar3 mas %odem tornar o c9digo di06cil de ser entendido. $e algu. Vale ressaltar "ue "uanto maior o esco%o de uma &ariá&el mais in0orma1ão seu nome de&e 0ornecer. Assim3 utili/e maior detal4e em identi0icadores de &ariá&eis globais e nomes mais sim%les em &ariá&eis locais.bser&e "ue alguns desses %re0i:os são G*i%os com%ostosH.

Inte0er- aso e:ista necessidade de mais de uma &ariá&el do mesmo ti%o3 adota>se a seguinte con&en1ão <.<<=ndice para um arra5 de caracteres vac#rra5 .FP.KOE*. 67arviSalario . Kasicamente os com%onentes %odem ser &isuais ou não>&isuais. recomenda3 %ois redu/ a legibilidade do c9digo>0onte. Kaseado em om%onentesD Del%4i 0ornece "uase duas centenas de com%onentes com os "uais o %rogramador %ode construir suas a%lica18es. seguinte 0ragmento de c9digo mostra como dois %re0i:os com%ostos GaH e Gi:H3 de0inem &ariá&eis "ue %odem ser utili/adas -untasD var vc . &oltada ao ambiente Korland Del%4i3 uma 0erramenta 'AD <'a%id A%%lication De&elo%ment= %ara a %lata0orma PindoQs <R:/FE35*/ 2000/BP= sendo bastante em%regada no desen&ol&imento de a%lica18es "ue mani%ulam bancos de dados liente/$er&idor. @. &isual3 orientado a ob-etos e baseado em com%onentes e e&entos.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.rientado a .11.m adotaremos uma nomenclatura %adrão %ara os com%onentes. .2008 Versão PO. E3 %or ser orientado a ob-eto3 %ermite a cria1ão de no&os com%onentes a %artir de com%onentes -á e:istentes. var vc7 . 5a nomenclatura a"ui de0inida3 0ica um es%a1o aberto3 %ara "ue na necessidade de no&os %re0i:os3 se-am 0eitas adi18es N lista3 ressaltado "ue essas adi18es de&em ser de&idamente documentadas. Del%4i . VisualD o %rogramador constr9i as -anelas e diálogos de suas a%lica18es dinamicamente3 minimi/ando a digita1ão de c9digoS .b-etoD Del%4i tra/ todas as caracter6sticas de uma %oderosa linguagem orientada a ob-eto > enca%sulamento3 4eran1a e %olimor0ismo.$ E . 67arvixc .01 Página 1.@ . om%onentes tamb.5E5*E$ <DELP!+= A nomenclatura a%resentada nesta se1ão . .0 @ / 26 utili/ados como %re0i:os %ara outros %re0i:os. arra5>)??)((@ of 67ar. uma &ariá&el.<<arra5 de caracteres 5a nomenclatura de0inida neste documento basta a%enas colocar o %re0i:o V gra0ado em letra minCscula %ara identi0icar "ue o elemento mani%ulado . ada com%onente re%resenta um elemento da a%lica1ão3 como um ob-eto de inter0ace de usuário3 um banco de dados3 ou uma 0un1ão de sistema.s com%onentes &isuais %odem ser &istos Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .b-ect Pascal=D var vsNomeA vsEnderecoA vs6idade . Escol4endo e conectando estes elementos3 &ocê constr9i a inter0ace de sua a%lica1ão. Inte0er. . Strin0- Vale a%enas obser&ar "ue3 %ara e0eitos de otimi/a1ão de c9digo3 muitas &e/es3 %ode>se a%ro&eitar a mesma &ariá&el %ara outra tare0a3 contudo tal %rática não . *amb.m %odem %ossuir um mani%ulador <4andle= de e&ento "ue %ermite receber e res%onder a ti%os es%ec60icos de entrada.

01 Página 1.2008 Versão PO. A tabela seguinte3 não e:austi&a3 mostra alguns e:em%los da a%lica1ão dessa regraD Sequência Descrição Botões 33 it tn 3t utton s3 Speed utton !ormu"#rios dm "ataCodule fo 4orm fa 4rame rel 'elatório %ditores e &'tu"os ed Edit mD CasDEdit c3 6om3o ox c7 67ecD ox col 6olumn l3 !a3el pn 8anel d3ed " Edit d3lc3 " !ooDup6om3o ox 03 2roup ox re 'ic7Edit so3 Scroll ox 0c7 2roup67ecD ox )istas e *rids 0d " 2rid lc3 !ooDup6om3o ox lst !ist1ie9 ls3 !ist ox 7ed Eeader de 6oluna s37 Scroll ar Eorizontal p0 8a0e6ontrol st0 Strin02rid ta3 %a3S7eet tre %ree1ie9 Banco de Dados t3 %a3le ds "ataSource d3 "ata ase dst "ataSet p3 8ro0ress ar 0a 2au0e Elaborador Sequência Descrição Imagens. A nomenclatura . Container e Tempori ador ole B!E 6ontainer im0 Ima0en tm %imer out But!ine $enus mm pm itm (utros sl CainCenu 8opupCenu ItemCenu Strin0!ist A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . 5o caso de nomes de com%onentes com%ostos utili/ar a %rimeira letra de cada um dos nomes.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.11.0 6 / 26 durante a e:ecu1ão da a%lica1ão3 en"uanto "ue os com%onentes não>&isuais s9 %odem ser &istos em tem%o de %ro-eto. com%osta ordenadamente da seguinte 0ormaD 2ma se"Tência3 0ormada %or letras maiCsculas3 e:tra6da das iniciais ou da inicial do nome do com%onente base.

11.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas Fr Guer5 01. . Estes itens de menu estão relacionados aos %adr8es de acesso "ue delimitam o acesso aos recursos dos sistemas3 de&endo %ortando obedecer Ns restri18es a%resentadas.2008 Versão PO. HuH(minIsculo) %recedendo o nome do m9dulo3 segundo con&en1ão. 5esta nomenclatura &amos caracteri/ar um m9dulo como sendo algo similar a uma 2nidade <2nit= em .uanto aos itens de menu <com%onentes Fenu+tem=3 seus nomes <%ro%riedade name= de&em estar limitados a 1@ caracteres.b-ect Pascal. Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .H identi0ica consulta. .01 Página 1..3 estarão arma/enadas em um m9dulo denominado u4ile.6 25+DADE$ E:istem &árias de0ini18es3 sobre o "ue &em a ser uma unidade. @. identi0icador escol4ido %ara com%or -untamente com o %re0i:o o nome do m9dulo de&e ser o nome do elemento básico "ue o m9dulo mani%ula.* #L???LMLaL???LzL(L???LN .. 5o menu %rinci%al da a%lica1ão3 con0igurar nomes dos itens de menu da seguinte maneiraD Jnome$itemK . Para nomeá>los3 &amos usar o %re0i:o G /H seguido de um nome "ue es%eci0i"ue o ob-eti&o básico do m9duloS ou se-a3 "uando ti&ermos &árias rotinas e &ariá&eis3 com algo em comum3 &amos de0ini>las e arma/ená>las em um Cnico lugar. %re0i:o GcH identi0ica adastroS GrH identi0ica 'elat9rio e G.0 U / 26 . Por e:em%loD as rotinas de mani%ula1ão de ar"ui&osD fBpen4ile3 fSeeD4ile3 etc..* c L r L F Jidentificador$itemK .* JprefixoKJidentificador$item K JprefixoK .

11. E:em%losD m9dulo de cadastro de clientes .m .2008 Versão PO. 0alse3 en"uanto if ( fIsBctal (vc"i0ito)) t7en ??? dei:a claro "ue a 0un1ão retorna true3 se o argumento . utili/ada %ara nomes de 0un18es/%rocedimentos. nomeado u'el8E6liente. nomeado u6ad8E6lienteS m9dulo de relat9rio de clientes . 5o caso es%ec60ico desta3 o nome da 0un1ão/%rocedimento anterior 0icaria assim fc6alculaSalario3 caso 0osse um %rocedimento seria pc6alculaSalario. @. Pre0ira os comentários no cabe1al4o das rotinas3 Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . nomeado uCovC48edidos @.Kons comentários não %odem mel4orar uma má codi0ica1ão3 mas comentários ruins %odem com%rometer seriamente o entendimento de uma boa codi0ica1ão. true e "ual .s nomes de 0un18es de&em basear>se em &erbos ati&os3 "ue %odem ser seguidos %or substanti&osD vi1alor . 2m uso combina um &erbo e um substanti&o %ara descre&er a 0un1ão/%rocedimento3 como %or e:em%lo3 6alculaSalario.Fuitos %rogramadores caem numa das duas categorias e:tremasD a"ueles "ue escre&em %ouco ou nen4um comentário3 e a"ueles "ue comentam em demasia. m9dulo de %es"uisa de clientes . octal e 0alse em caso contrário. E:istem di&ersos GdialetosH encontrados. nomeado uImpC4Extrato m9dulo de mo&imenta1ão de %edidos .FE5*J'+.U A25VWE$ E P'.$ A nota1ão !Cngara tamb. Adotaremos um estilo3 %ara "ue a legibilidade e a manuten1ão de %rogramas não se tornem uma tare0a GindigestaH. 2se nomes ati&os %ara 0un18es.01 Página 1.* %runc (vd6oeficiente)S7o9Cessa0e(+Erro de a3ertura no arFuivoOP)- As 0un18es "ue retornam um &alor booleano <true ou 0alse= de&em ser nomeadas %ara "ue o &alor de retorno não gere ambigTidades. . m9dulo de im%orta1ão de ar"ui&os .$ omentários constituem a %arte mais signi0icati&a da documenta1ão interna.0 8 / 26 Logo a%9s o G/H3 de&e ser descrita a 0un1ão do m9dulo3 utili/ando as três %rimeiras consoantes ou letras da 0un1ão do m9dulo.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.8 . 5o nosso caso3 utili/aremos sem%re um GfcH ou um G0cH minCsculo %ara identi0icar 0un1ão e %rocedimento3 res%ecti&amente. Para isso &amos adotar algumas normas e regras3 uma delas con4ecidas como G%rettM>%rintingH. o dialeto "ue será adotado a"ui nesta nomenclatura. nomeado u8sF8E6liente. 5ão e:iste um Cnico estilo de codi0ica1ão3 uma &e/ "ue o gosto %essoal %ode determinar di0erentes estilos. ED+FE5*. Este . AssimD if ( f67ecDBctal (vc"i0ito)) t7en ??? não indica "ual &alor de retorno .

' . . @ # . o seu c9digo 0unciona em um comentárioD . E:em%loD Q1erificação da existRncia do 4uncionário na ta3ela SSSSH códi0o ??? 2 # Entre o c9digo e o comentário de&e e:istir uma lin4a em branco. Para os comentários nos c9digos elaborados são adotadas as seguintes regrasD 1 # .2E ela 0a/ isso.R AKEVAL!. de "ue os comentários e a codi0ica1ão de&em estar coerentes entre si. I im%ortante obser&ar "ue os comentários não de&em re%etir a codi0ica1ão3 mas e:%licá> la e au:iliá>la.F.uando . E:em%loD Q1erificação da existRncia de funcionário na ta3ela o%$4uncionarioA e retorno do nome do mesmo 7d7d7d7d7d7d7 d7d7d7d7d7d7d7d7d7d7d77dH E # . @.bser&ar o taman4o Ctil da tela3 ou se-a3 não ultra%assar %ara outra tela o comentário3 obrigando o obser&ador a rolar a tela %ara &isuali/ar uma lin4a. comentário de&e ser sem%re antes do c9digo.11.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.$ • • • • 5o in6cio de cada unidade inserir um cabe1al4o es%eci0icando os seguintes itensD 2nidadeS AutorS Data de ria1ãoS Aun1ãoS Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .2008 Versão PO. 2m outro item a ser lembrado3 e "ue com 0re"Tência . 525 A tente e:%licar . uidadoD não en0ati/e o 9b&io3 não contradiga o c9digo e não comente c9digo ruim3 reescre&a>o. +sto re"uer "ue o %rogramador le&e em conta dois %ontos de &istaD o do %rogramador e o do documentador3 a&aliando com%letamente os ob-eti&os de cada um. Q1erificação da existRncia do 4uncionário na ta3ela SSSSH () lin7a em 3ranco) códi0o ??? ? # . 5ormalmente nos editores de c9digo este limite 0ica entre 60 e 80 caracteres. 0eita altera1ão em %rogramas/manuten1ão es%eci0icar nome do autor da mudan1a3 data e 4ora e3 se necessário3 c9digo antigo no cor%o do comentário. $e 0or 0eita uma mudan1a na codi0ica1ão3 de&emos nos assegurar de "ue tal mudan1a re0lita>se nos comentários relacionados.01 Página 1. taman4o do comentário de&e assumir %osi1ão intermediária3 no má:imo ? lin4as3 mas "ue descre&a bem a o%era1ão reali/ada. muito mel4or escre&er o c9digo %ara "ue o modo como 0unciona se-a 9b&io e naturalmente com%reens6&el. Pode>se 0a/er %e"uenos comentários %ara noti0icar ou a&isar sobre algo %articularmente interessante <ou 0eio=3 mas tente e&itar e:cessos.0 R / 26 a&isando Ns %essoas o "ue ela 0a/3 e %ossi&elmente P. es"uecido3 . comentário de&e ser alin4ado N es"uerda da margem de codi0ica1ão na tela.

Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas E:em%loD 01. realvi"ia . 4a3io #lexandre Span7ol "escrição .10 A.0 10 / 26 T-------------------------------------------------------------------------------&nidade .'FA*AVX.(() #utor .2008 Versão PO.(() #utor . strin0vrSalario . 2ma instru1ão com%osta anin4ada . @. inte0er- .m será seguida a abordagem %adrão denominada G%rettM%rintingH. (.<(U<. alin4amento de&e ser 0eito %elo maior identi0icador3 no caso anterior vrSalario. uImp'sp6andidato?pas "ata 6riação. 4a3io #lexandre Span7ol "escrição . 5a 0ormata1ão do c9digo>0onte3 tamb.bser&ando o e:em%lo anterior &imos "ue de%ois do se%arador < D = e:iste um es%a1o e o ti%o %rimiti&o.end- 2m 0ormato recuado semel4ante 0re"Tentemente .01 Página 1. &nidade responsável pela importação das respostas dos candidatos 0eradas pela leitora ótica em arFuivo texto? ---------------------------------------------------------------------------------V *odas as altera18es de&em ser documentadas3 indicando no in6cio da unidade Autor da modi0ica1ão3 data em "ue ela ocorre e a descri1ão da altera1ão. $ua regra . usado %ara lista de &ariá&eis ou ti%os de dados3 como nos 0ragmentos de c9digo abai:oD %5pe %p!etras * set of c7arvar vsNome . .<(U<. Por e:em%lo3 na linguagem PascalD if ??? t7en 3e0in if ??? t7en instrução)instrução. delimitador de in6cio de bloco de&e come1ar na mesma lin4a da instru1ão3 e de 0im de&e estar alin4ado com o in6cio da mesma. sim%lesD cada &e/ "ue &ocê %recisar escre&er uma instru1ão com%osta3 a&ance>a 2 es%a1os %ara direita do restante da instru1ão atual. &nidade responsável pela importação das respostas dos candidatos 0eradas pela leitora ótica em arFuivo texto? ---------------------------------------------------------------------------------V omentário %ara 0un18es e %rocedimentosD T-------------------------------------------------------------------------------"ata 6riação.11. . (. a&an1ada E es%a1os3 e assim %or diante. Por e:em%loD Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .

uando não esti&er em 0ocoD 0undo branco e 0onte *a4oma3 taman4o 8 da cor a/ul>marin4o <')K 0303128=.uando desabilitadoD 0undo cin/a claro <')K 2E?32E?32E?= e 0onte *a4oma normal3 taman4o 8 e cor cin/a m.11 . o .2008 Versão PO. E:em%lo em .m de&em ser seguidos.0 11 / 26 Para o comando de atribui1ão &amos adotar a seguinte nota1ãoD 2m es%a1o em branco de%ois do identi0icador3 o comando de atribui1ão3 um es%a1o entre ele e o outro identi0icador ou o%erador.* vi5vix .* vi5 W )(- *odas as 0un18es e %rocedimentos3 "uando da sua im%lementa1ão de&em come1ar na coluna 1 da tela. Por e:em%loD vix .5*E$ 2tili/ar as seguintes recomenda18esD • Aormulário <Aorms=D 0undo branco total. Al. • am%os de edi1ão <Edits3 DKEdits e similares=D o .uando esti&er em 0ocoD 0undo amarelo claro <')K 22132?832@E= e 0onte *a4oma3 negrito3 taman4o 8 da cor a/ul <')K 030321@=.dio <')K 1@U31@U3161=.01 Página 1.m disso3 de&e 4a&er um es%a1o em branco entre os %arênteses da 0un1ão e delimitador de in6cio de bloco. inte0ervar O? 3e0in O end- . o .Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas If (???) t7en 3e0in ??? end- 01.11. Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .b-ect>PascalD function fStoX (?????A?????).'E$ E A. • '9tulos <Labels=D Aonte Arial3 taman4o 8 e cor %reta.s limites de tela es%eci0icados %ara comentários em c9digo tamb. @.

5as -anelas de edi1ão3 as 4ot>(eMs de0inidas sãoD +ot. 6. A organi/a1ão dentro de cada item do menu %rinci%al de&e agru%ar %or 0un18es/ ati&idades correlacionadas os subitens.2 *E LA$ DE A*AL!. 4. .? FE52 P'+5 +PAL A -anela %rinci%al do a%licati&o de&e %ossuir uma barra de menus sus%ensos na %arte su%erior e uma barra de status na %arte in0erior.1 E$*'2*2'A DE FE52$ 01. Esse %rocedimento . &álido %ara itens de menu3 bot8es ou cam%os de edi1ão. .-e. Por con&en1ão3 a tecla sublin4ada será a %rimeira letra do identi0icador ou outra "ue ten4a seu uso -á %adroni/ado nas a%lica18es F$>PindoQs.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 1. . A tecla de atal4o 0icará sublin4ada e o acesso será obtido %elo %ressionamento simult[neo da tecla AL* e da tecla de atal4o dese-ada. As teclas de atal4o seguem o %adrão da inter0ace do F$>PindoQs.2008 Versão PO. ESTRUTUR" (O SISTEM" 6. %osicionamento dentro de cada agru%amento <ordem= de&e ser a 0re"Tência de sua utili/a1ão3 assim itens utili/ados mais 0re"Tentemente %recedem os itens menos acessados. Essa -anela não de&e %ermitir "ue o usuário e0etue o%era18es "ue a redimensione ou a re%osicione de 0orma arbitrária. Por tal moti&o3 tais itens são bastante &ariá&eis3 contudo geralmente estão di&ididos em adastro3 onsultas3 'elat9rios e A-uda. \ e +5$E'*.01 Página 1. 5a barra de t6tulo da -anela %rinci%al <ca%tion bar=3 a%enas os bot8es minimi/ar e 0ec4ar de&em estar 4abilitados. Algumas 0uncionalidades dos a%licati&os de&erão ser acess6&eis %elo %ressionamento de determinadas teclas3 denominadas 4ot>(eMs. %rimeiro item do menu %rinci%al de&e conter como sua Cltima o%1ão o item $air3 "ue 0inali/a o a%licati&o. Esse item de&e res%onder N combina1ão de teclas Y *'LZY$Z como tecla de atal4o.11.s r9tulos dos itens do menu %rinci%al de&em ser coerentes com as 0un18es desem%en4adas no sistema. Esc 4) 4. estado das teclas AP$ L.0 12 / 26 . \3 52F L.s indicadores AP$3 Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . omo dito3 na %arte in0erior da -anela encontra>se a barra de status3 e:ibindo algumas in0orma18es do ambiente de o%era1ãoD • A data atual do sistema o%eracionalS • A 4ora atual do sistema o%eracionalS • . 4U 4/ 4[ 6%'! W 8 !unção 4ec7a a Yanela ativa Exi3e a documentação on-line da aplicação Inicia um novo re0istro na tela Salva as alteraçZes atuais #ltera o re0istro selecionado "esfaz as alteraçZes no re0istro Exclui o re0istro atual Imprime a lista de re0istro ativa 6.

2008 Versão PO.11.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01. banco de dados no "ual o sistema está conectadoS A identi0ica1ão do com%utador no "ual a base de dados locali/a>seS A identi0ica1ão do usuário "ue está logado no sistemaS E o %ercentual de mem9ria dis%on6&el no sistema o%eracional. Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . .0 1? / 26 • • • • 52F e +5$ estarão ati&os caso a tecla corres%ondente este-a ligada ou inati&os caso a tecla corres%ondente este-a desligada no momentoS .01 Página 1.

+AVWE$ As classes "ue ti&erem uma rela1ão %or associa1ão ou agrega1ão3 de&erão ser nomeadas con0orme o modelo a seguirD Si3ta4e5 0ro0ert7 Ynome da classe sem %re0i:o e sem m9duloZ 5 Yti%o classeZ read fYnome classeZ 8rite fYnome classeZS Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .? A$$.01 Página 1.0 1E / 26 2.1 5.11.2 !E'A5VA *odas as classes de&em 4erdar de G*PersistenciaH.D cl$)2suarios Si3ta4e C6ass'ameD * ] Ysigla do m9duloZ ] Ynome da classeZ E:. U.FE5 LA*2'A$ A nomenclatura "ue de&erá ser utili/ada %ara a cria1ão de unidades contendo regras de neg9cios será con0orme as es%eci0ica18es a seguirD Si3ta4e U3it5 cl ] Ysigla do m9duloZ ] Ynome da classeZ E:.2008 Versão PO.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01. Esta %or sua &e/3 tem as 0un18es necessárias %ara a comunica1ão com o banco de dados. ESTRUTUR" (E C#"SSES U.D *$)2suarios U.

'F2LJ'+.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.1 DEF. E5*'E A. ESTRUTUR" (E *ORMU#ÁRIOS 8.uanto ao conteCdo3 os r9tulos de cam%os de edi1ão cu-o Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .01 Página 1. . Si3ta4e U3it5 u ] Yti%o 0ormulárioZ ] Ysigla m9duloZ ] Ynome do 0ormulárioZ E:D u ad$)2suarios Si3ta4e 'ame5 0o ] Yti%o 0ormulárioZ ] Ysigla m9duloZ ] Ynome do 0ormulárioZ E:.$ Para reali/ar a lim%e/a dos cam%os automaticamente . .E . . 8. necessário %reenc4er a %ro%riedade G*agH dos cam%os.11./eridos:. Em um Cnico 0ormulário %ode ser necessário im%lementar mais de um Aorm*o lass.F25+ AVX.$ E LA$$E$ Procedime3to 0c*ormToC6ass5 Este %rocedimento alimenta os atributos da classe com os &alores dos cam%os do 0ormulário. Assim a 0un1ão fcRe.$ AFP.s cam%os obrigat9rio nas inter0aces %ara o usuário 0inal3 de&erão estar indicados com um asterisco <_= a es"uerda do r9tulo do cam%o. I %oss6&el de0inir gru%os de cam%os a serem lim%os "uando necessário3 sim%lesmente de0inindo as tags com o mesmo &alor.s cam%os "ue %ossu6rem &alor >1 na %ro%riedade *ag não são lim%ados.K'+)A*^'+.2 AFP. nome deste %rocedimento obedece a seguinte sinta:eD Si3ta4e5 %cAorm*o lass ] Ynome classeZ Procedime3to 0cC6assTo*orm5 Este %rocedimento alimenta os cam%os do 0ormulário com os &alores dos atributos da classe. nome deste %rocedimento obedece a seguinte sinta:eD Si3ta4e5 %c lass*oAorm ] Ynome classesZ Visualmente3 os r9tulos <labels= de&em estar %osicionados do lado es"uerdo do cam%o com o te:to alin4ado N direita.0 1@ / 26 9. .? L+FPE`A D. A nomenclatura %adrão %ara denominar 0ormulários de&erá seguir a regra tanto %ara o nome da GunitH3 "uanto %ara a %ro%riedade G5ameH dos 0ormulários. 8.D 0o ad$)2suarios 8. locali/ada no 0ormulário mestre foMestre irá &alidar a entrada destes cam%os "ue necessitam ser %reenc4idos %elo usuário.F+5AVX. Em um Cnico 0ormulário %ode ser necessário im%lementar mais de um lass*oAorm.$ .$ .2008 Versão PO.

Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .0 16 / 26 %reenc4imento . gru%o de comando G"ç=es H somente de&erá ser e:ibido caso e:ista o%era18es de comandos %ertinentes a cada 0ormulário em es%ec60ico. PE$. F. A. Ve-a a seguir a de0ini1ão dos bot8es e:istentes %ara na&ega1ãoD • Se6ecio3arD ca%tura o<s= registro<s= selecionado<s= %ara atribuir em uma outra inter0ace.11. • Co3s/6tarD &isuali/a os dados o registro com maiores detal4es. obrigat9rio de&em a%resentar um asterisco <_= %recedendo a descri1ão. • 'o<oD Adiciona um no&o registro na lista de cadastro a%resentada. Por e:em%lo3 numa tela de cadastro de %edidos3 este 0ormulário de&erá ter uma a1ão denominada GA%ro&ar %edidoH3 ou então G ancelar %edidoH.D.2+$A *odos os 0ormulários "ue mani%ulam registros em massa de&erão %ossuir em sua lateral es"uerda contendo os bot8es de 'a<egação "ue são as o%era18es e:ecutadas sobre os registros3 .'F2LJ'+.DEL.2008 Versão PO. *endo um cam%o de edi1ão "ue se-a 4a&e Primária <%rimarM (eM= recebido 0oco3 não %ode ser %ermitido o %rosseguimento de digita1ão a menos "ue o usuário in0orme um &alor %ara tal cam%o. # F.01 Página 1.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.

A -anela de %es"uisa .Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.0 1U / 26 • Sa6<arD on0irma a o%era1ão atual3 sal&ando as altera18es/inclus8es e0etuadas ou iniciando um %rocessamento. # F. ED+VX. • C6o3arD reali/a uma c9%ia dos dados do registro selecionado %ara 0acilitar a digita1ão e a%enas algumas altera18es. • Pes. F. $em%re de&erá ser a%resentada uma cai:a de diálogo solicitando uma con0irma1ão do usuário %ara e0eti&ar a transa1ão de e:clusão.01 Página 1. Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . a%resentada mais adiante.D. • Ca3ce6arD Anula a o%era1ão atual3 não e0etuando "ual"uer altera1ão/inclusão. • "6terarD abre o cadastro com os cam%os necessários %ara a atuali/a1ão do registro. • Pr>4imo5 seleciona os dados do %r9:imo registro %ara &isuali/a1ão.2008 Versão PO./isarD A%resenta a -anela de %es"uisa3 0ornecendo ao usuário uma maneira de locali/ar registros -á inclusos na base de dados. • E4c6/irD 'emo&e o registro "ue esti&er em edi1ão no momento. A.DEL. • "3teriorD seleciona os dados do registro anterior %ara &isuali/a1ão.11. • E40ortarD este comando será utili/ado %ara e:%ortar em uma %lanil4a E:cel somente os dados "ue estão listados. • Im0rimirD en&ia %ara a im%ressora os registros e:ibidos na lista de cadastro.'F2LJ'+.

>determinado3 de&em %ossuir um cabe1al4o contendo a identi0ica1ão do sistema3 o t6tulo do relat9rio3 a %ágina atual3 o nCmero total de %áginas e a data/4ora de gera1ão do relat9rio.uando a o%1ão de relat9rio 0or acionada3 de&e ser e:ibida a -anela de %re&ieQ %adrão3 con0orme mostrado na 0igura seguinte. . A -anela de %re&ieQ de&e 0ornecer al. cor%o do relat9rio . A -anela do %re&ieQ a%resenta3 no to%o logo abai:o a barra de t6tulos3 uma barra de 0erramentas com%osta %or tre/e controles. *ais controles3 da es"uerda %ara direita3 têm as seguintes 0un18esD • E:ibe a %rimeira %ágina do relat9rio solicitado • 'etorna uma %ágina • E:ibe o nCmero da %ágina atual. RE#"T@RIOS 01. &ariá&el e de%endente do ti%o de relat9rio a ser im%resso.s relat9rios3 N e:ce1ão de relat9rios %ara documentos com laMout %r. aso um dos Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . .2008 Versão PO. +n0ormado um nCmero de %ágina nesse cam%o de edi1ão e teclando>se JEnterK tal %ágina será e:ibida3 caso ela e:ista.0 18 / 26 .m da &isuali/a1ão as %ossibilidades de im%ressão e e:%orta1ão do relat9rio %ara 0ormatos comumente utili/ados como '*A3 PDA3 KFP3 OP) e !*FL.11.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas ?.01 Página 1.

11.2008 Versão PO.01 Página 1.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01. cam%o de edi1ão %ermite a escol4a de um &alor arbitrário de /oom e re0letirá as mudan1as de /oom causadas %elo acionamento de "ual"uer um dos controles de /oom A-usta o %ercentual de /oom %ara e:ibir a %ágina toda A-usta o %ercentual de /oom %ara a largura da %ágina A-usta o %ercentual de /oom %ara 100a A%resenta a cai:a de diálogo de im%ressão A%resenta a cai:a de diálogo "ue %ermite sal&ar o relat9rio em di&ersos 0ormatosD '*A3 PDA3 BL$3 *B* dentro outros ancela a im%ressão do relat9rio Aec4a a -anela de %re&ieQ Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . .0 1R / 26 • • • • • • • • • • controles de mo&imenta1ão de %ágina se-a utili/ado3 o nCmero de %ágina a%resentado nesse cam%o de edi1ão re0letirá a mudan1a de %ágina A&an1a uma %ágina E:ibe a Cltima %ágina do relat9rio solicitado ontrola o %ercentual de /oom de e:ibi1ão.

2008 Versão PO.s nomes das tabelas de&erão estar no $+5)2LA'3 e tamb.01 Página 1. um ob-eto no banco de dados do ti%o *abela.m receberão uma nomenclatura %adrão %ara a elabora1ão. Abai:o segue o esco%o %ara a nomea1ão das tabelas con0orme a necessidade T W Jsi0la móduloK W Jradical ta3elaK W Jnome compostoK E:em%losD T8\8roYeto T8E8essoa T8E8essoa6ontas T868rocesso T8\8roYeto%axas T#G6ompra6otacao8rocesso T#G6ompra6otacaoItens Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . PERSISTA'CI" (E ("(OS 01.1 *AKELA$ .0 20 / 26 As tabelas3 triggers3 stored %rocedures3 ud0s3 &ieQs modeladas no banco de dados tamb.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 10. $eguindo esta %adroni/a1ão3 .m sem%re iniciar com o %re0i:o GTH %ara identi0icarmos "ue . %oss6&el assimilar o entendimento de "ual"uer ob-eto criado na base de dados.s nomes dos cam%os de&erão %ossuir a %rimeira letra em maiCscula e o restante em minCsculo3 e "uando e:istir nomes com%ostos3 a %rimeira letra do segundo nome de&erá estar em cai:a alta. .11. Ve-a abai:o os e:em%los de ob-etos "ue de&erão ser nomeados no banco de dadosD 10.

D!"#$i%&o Forma de identificação de um objeto ou de um indivíduo.a de uma tabela. $O0# $10#.a2ão entre as variaç@es de duas grande2as das :uais a primeira " dependente da segunda( geralmente aplicado a um tributo 3imposto( . Designa dados cuja origem e prime uma representação do seu conte!do atrav"s de algum tipo de codificação. $ão usar 832ero5 ou 93um5.& %&?& %#?%O %IPO 7&.? *'+))E'$ .O. %empo determinado.11. Indica ordem ou s"rie. $!mero atribuído pelo sistema ou pelo D/ para identificar um objeto ou lin.0 21 / 26 .ora( minuto( segundo* ou '. Palavra3s5 com :ue se designa pessoa ou objeto. ED2'E$ A nomenclatura desses iniciar com o %re0i:o G 0H %ara identi0icarmos "ue .01 Página 1. Ponto no tempo em 'dia( m)s( ano* ou 'm)s( ano*.'ED P'.IO ID#$%IFIC&DO.5 Conjunto de palavras para informar ou comentar alguma coisa.$ DA$ *AKELA$ 01. Abai:o segue o esco%o %ara a nomea1ão das tabelas con0orme a necessidade tr W Jsi0la móduloK W Jnome ta3ela s<prefixo %K W Jação tri00erK E:em%losD tr8\8roYeto!o0Insercao tr8\8roYeto!o0#lteracao tr8\8roYeto!o0Exclusao 10.C#$%1&. Composição de '. PC P< >% +G %? 00 %P 7.2 AFP.s nomes de cam%o das tabelas de&erão res%eitar um %re0i:o de nomenclatura con0orme a tabela abai:oD Título CODIGO CO#FICI#$%# D&%& D#+C. Pode assumir apenas dois valores( true ou false( 7 ou F..&. 1tili2ado para dados de nature2a Imagem 34P#G( /0P( %IF( GIF( etc. #spaço de tempo durante o :ual deve reali2ar=se alguma coisa. Classificação de algum objeto ou pessoa O e:uivalente justo em din. Sigl CD CO D% D+ -. Designa os dados cuja nature2a e prime uma parte proporcional calculada sobre uma :uantidade de cem unidades. $!mero de unidades( :ue determina um conjunto de coisas consideradas como e:uivalentes e suscetíveis de aumento e diminuição .s nomes das triggers de&erão estar no $+5)2LA'3 e tamb.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 10. Parte num"rica em um produto de fatores num"ricos.m sem%re iniciar com o %re0i:o GtrH %ara identi0icarmos "ue . .&<O >1&$%ID&D# +IG.ora( minuto*.5. 6 um 'flag*. Conjunto de palavras citadas para descrever alguma coisa.IC&O -O.eunião de letras de uma denominação ou título.. I0&G#0 I$DIC&DO..epresentação de palavras por meio de algumas sílabas ou letras. Em caso de stored %rocedures "ue são do ti%o relat9rio3 ou se-a3 a%9s a e:ecu1ão Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .E $*. P. um ob-eto no banco de dados do ti%o $tored Procedure. .O P#.eiro 3:ual:uer dado :ue e presse moeda5.2008 Versão PO. um ob-eto no banco de dados do ti%o *rigger. 10. ID I0 FG $0 $.

Abai:o segue o esco%o %ara a nomea1ão das store %rocedures con0orme a necessidade pc W Jsi0la móduloK W Jradical store procedureK W Jnome açãoK pcre" W Jnome relatórioK E:em%losD pc8\8roYetoExcluir pc8E8essoaInserir pc8E8essoa#lterar pcre"6B alancoCensal pcre"6B!ivro'azao pcre"6B!ivro4inanceiro 10. Ainda no nome da 0un1ão .2008 Versão PO. um ob-eto no banco de dados do ti%o VieQ. necessário colocar o ti%o do dado "ue ela retorna3 %ara 0acilitar o entendimento e uso da 0un1ão.6 V+EP$ .Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.01 Página 1.s %re0i:os dos ti%os de dados seguem a norma de declara1ão de &ariá&eis3 ou se-a3 os %re0i:os usados %ara identi0icar a ti%agem da &ariá&el.11.5$ E 2DAs .s nomes das 0un18es de&erão iniciar com o %re0i:o G fH %ara identi0icarmos "ue .@ A25 *+. um ob-eto no banco de dados do ti%o Aunction. .0 22 / 26 origina um relat9rio %ronto %ara a 0ormata1ão3 será necessário acrescentar no %re0i:o %adrão o seguinte caracter Gre6H. Abai:o segue o esco%o %ara a nomea1ão das tabelas con0orme a necessidade v2 W Jsi0la móduloK W Jradical ta3ela principal na vie9K W Jnome da vie9K Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . fc W /tipo dado0 W Jradical funçãoK W Jnome funçãoK E:em%losD fc1Is6846N8\()fciB3temSetor()fcsB3tem'azaoSocial()fct1B3tem!ista8essoas()fc1Is4uncionario8E'#E()fcd6alcula%axa()- 10.s nomes das 0un18es de&erão iniciar com o %re0i:o G <8H %ara identi0icarmos "ue .

0 2? / 26 Em caso de &ieQs "ue são do ti%o relat9rio3 ou se-a3 a%9s a consulta origina dados %ara a 0ormata1ão3 será necessário acrescentar no %re0i:o %adrão o seguinte %re0i:o G re6H.s nomes dos usuários criados no banco de dados de&erão com um determinado %re0i:o3 %ois3 %ara cada n6&el de %ermissão o usuário terá um %re0i:o identi0icando o usuário.11. necessário colocar um su0i:o Gtm%H no 0inal do noma da base.8 2$2J'+.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas E:em%losD v2"6Nota4iscal v2#G6ompra6otacao v28\8roYetos v28\8roYeto%axas v28E8essoas v28\8essoa6ontas 01. um ob-eto no banco de dados do ti%o DataKase. Abai:o segue o esco%o %ara a nomea1ão das tabelas con0orme a necessidadeD d1 W Jnome da 3ase de dadosK E:em%losD d14unpar d14inacon d12N8 d1'E4unpar Aten1ãob Para bases de dados de teste . v2re" W Jsi0la móduloK W Jradical ta3ela principal na vie9K W Jnome da vie9K E:em%losD v2re""6Nota4iscal#nalitico v2re"#GCapa6otacao v2re"8\"ados8roYetos v2re"8\"ados8roYetos%axas v2re"8E!ista8essoas v2re"8E8essoa6ontas 10.U DA*AKA$E$ .2008 Versão PO.01 Página 1. Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .$ . Ve-a abai:o os e:em%losD d14unpartmp d14inacontmp d12N8tmp d1'E4unpartmp 10.s nomes das bases de dados <database= de&erão iniciar com o %re0i:o GdbH %ara identi0icarmos "ue .

11.2008 Versão PO.0 2E / 26 Abai:o segue o esco%o %ara a nomea1ão das tabelas con0orme a necessidadeD Prefixo d3a uap uac uex ute 34ve" de Permissão #dministradores de anco de "ados &suário de acesso para as aplicaçZes &suário com acesso apenas para consultas &suário com acesso externo ou remoto &suário para sistemas de terceiros Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ .Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01.01 Página 1.

0ácil dei:ar de lado o estilo3 %ara se %reocu%ar com ele mais tarde. Essa %ode ser uma decisão cara.Procedimento Operacional Assunto Vigência Documento Regras de Codificação de Sistemas 01. mais 0ácil de ler e entender. 5a correria de terminar os %rogramas %ara atender algum %ra/o . Alguns dos e:em%los da &ida real mostram o "ue %ode dar errado3 se não 0or dada aten1ão su0iciente %ara o bom estilo. mesmo o c9digo "ue &ocê escre&er sob %ressão será mel4or. %reciso muito tem%o %ara dei:á>lo GbonitoH7 A0inal de contas3 as regras não são arbitrárias7 A res%osta . De%ois "ue eles se tornarem automáticos3 seu subconsciente tomará conta de muitos dos detal4es %ara &ocê e3 at. A %rinci%al obser&a1ão . Elaborador A%ro&ador arlos !enri"ue alesso # Analista de $istemas 'onald Vi&en(anda # )erente de *+ . menor "ue o c9digo "ue 0oi -ogado sem cuidado e nunca 0oi a%er0ei1oado. c9digo deslei:ado . c9digo ruim # não a%enas estran4o e di06cil de ler3 mas "uase sem%re "uebrado. Ele cont.uem se im%orta com a 0orma de um %rograma se ele 0unciona bem7 5ão . CO'C#US%O Por "ue se %reocu%ar com o estilo7 .m menos erros e %ro&a&elmente . "ue o bom estilo de&e ser uma "uestão de 4ábito.11.0 2@ / 26 11. . $e &ocê %ensar no estilo ao escre&er o c9digo3 e se &ocê re&isar e mel4orar esse c9digo estarão desen&ol&endo bons 4ábitos.01 Página 1. "ue o c9digo bem escrito .2008 Versão PO.

Sign up to vote on this title
UsefulNot useful