Você está na página 1de 25

Procedimento Operacional

Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

1 / 26

SUMRIO
7. ESTRUTURA DE CLASSES.................................................................................................................................................14 8. ESTRUTURA DE FORMULRIOS....................................................................................................................................15 11. CONCLUSO.......................................................................................................................................................................25

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


1. OBJETI O

01.11.2008
Verso

PO.01
Pgina

1.0

2 / 26

, ob-eti&o %rinci%al deste manual de %rocedimento o%eracional . normali/ar a codi0ica1o de sistemas desen&ol&idos internamente %ela 2nidade de )esto de *ecnologia de +n0orma1o. Atra&.s desta %adroni/a1o3 todos os sistemas tero "ue seguir 0ielmente as regras estabelecidas neste manual. !. "P#IC"$%O A a%lica1o deste manual ser a%enas %ara os sistemas "ue sero 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&ero a%licar este %adro em "ual"uer sistema. &. RESPO'S"BI#I("(ES abe a 2nidade de )esto de *ecnologia de +n0orma1o de0inir "uais so as regras &i&eis %ara a codi0ica1o3 e tamb.m acom%an4ar se o desen&ol&imento do sistemas esto sendo ade"uados con0orme a %adroni/a1o. ). (E*I'I$+ES ,ER"IS 5este manual tamb.m ser in0ormado a %adroni/a1o dos ob-etos criados no banco de dados3 com isso3 . %oss6&el ter uma organi/a1o 4omognea de todos sistema elaborado %ela unidade de *+. -. 'OME'C#"TUR" , "ue . um identi0icador7 2m identi0icador de &ari&el ou 0un1o 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. 5o 4 restri1o %ara o em%rego de identi0icadores gra0ados em ingls <como &iValue= ou %ortugus <&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 *+

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


@.1 P'EA+B,$ +5D+ AD,'E$

01.11.2008
Verso

PO.01
Pgina

1.0

? / 26

, ob-eti&o dos %re0i:os . na &erdade 0ornecer ao %rogramador uma 0orma de identi0icar "ue ti%o de elementos ele est mani%ulando3 se . uma &ari&el3 uma constante3 um ar"ui&o ou outros. Estes %re0i:os sero ane:ados muitas &e/es aos %re0i:os bsicos da nota1o !Cngara. De&em estar em letra minCscula3 no in6cio do identi0icador3 e so os seguintesD
fc Identifica uma funo pc Identifica um procedimento c Identifica uma constante v Identifica uma varivel u Identifica uma unidade ou mdulo (opcionalmente pode-se utilizar o prefixo m)

@.2

,5$*A5*E$

Em geral3 . uma %rtica no muito 0eli/ colocar nCmeros tal como 1@ ou E00 em um %rograma3 os c4amados nCmeros mgicos. +sto torna seu c9digo di06cil de ser conte:tuali/ado. 5o lugar destes nCmeros de&ero ser utili/adas constantes simb9licas. *ais constantes so escritas em letras maiCsculas %ara serem di0erenciadas dos nomes de &ari&eis. Fas na nomenclatura a"ui de0inida &amos utili/ar3 al.m disso3 um G cH. , e:em%lo abai:o mostra algumas constantes simb9licasD
const cSENSI I!I"#"E$!EI%&'#() * +,+cSENSI I!I"#"E$!EI%&'#(. * +/+cSENSI I!I"#"E$!EI%&'#(, * +.+-

I im%ortante obser&ar "ue no momento da sele1o do nome da constante . recomend&el escol4er um identi0icador "ue e:%resse sua 0inalidade. , taman4o do nome de&e ser intermedirio3 ou se-a3 no muito curto e nem muito longo3 mas o su0iciente %ara e:%ressar o signi0icado de sua e:istncia. Em "ual"uer linguagem de %rograma1o3 as constantes simb9licas mel4oram a legibilidade de um %rograma e tornam sua manuten1o mais 0cil. Em &e/ de %rocurar em uma %il4a de c9digo 0onte "uando os &alores num.ricos so alterados3 a%enas uma lin4a de c9digo "ue de0ine o &alor de&e ser atuali/ada. @.? VA'+JVE+$ A cria1o de nomes de &ari&eis Cteis %ode ser um desa0io. 5omes curtos de &ari&eis so tentadores3 %ois so 0ceis de digitar3 mas %odem tornar o c9digo di06cil de ser entendido. $e algu.m tentar ler um c9digo em A,'*'A53 KA$+ 3 ,K,L ou li%%er saber do "ue se trata. Em contra%artida os nomes longos de &ari&eis %odem tornar o c9digo mais leg6&el3 mas sobrecarregam o %rogramador "ue ir digit>los. A utili/a1o de nomes longos tamb.m aumenta as c4ances de algum nome ser digitado incorretamente. A nota1o !Cngara <!ungarian 5otation=3 criada na Ficroso0t %elo Dr. 4arles $imonMi13 ocu%a uma %osi1o intermediria entre os dois e:tremos. 5ela3 os nomes de &ari&eis so criados colocando um %re0i:o curto diante de um nome mais longo e descriti&o. , %re0i:o descre&e o ti%o de dado re0erenciado %ela &ari&el. Em alguns casos3 um %re0i:o tamb.m descre&e a 0orma "ue uma &ari&el . utili/ada. Por con&enincia3 um %re0i:o %ode ser utili/ado
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

E / 26

isoladamente como um nome de &ari&el. 5esta nomenclatura estendida3 sero ane:ados tais %re0i:os a%9s o identi0icador de elemento <%ara &ari&eis o &=. Vale ressaltar "ue "uanto maior o esco%o de uma &ari&el mais in0orma1o 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. Em ,b-ect PascalD
var vc7 ; c7arvsName ; strin0-

@.E L+$*A DE P'EA+B,$ A cria1o de nomes de &ari&eis Cteis %ode ser um desa0io. 5omes curtos de &ari&eis so tentadores3 %ois so 0ceis de digitar3 mas %odem tornar o c9digo di06cil de ser entendido. $e algu.m tentar ler um c9digo em A,'*'A53 KA$+ 3 ,K,L ou li%%er saber do "ue se trata. Em contra%artida os nomes longos de &ari&eis %odem tornar o c9digo mais leg6&el3 mas sobrecarregam o %rogramador "ue ir digit>los. A utili/a1o de nomes longos tamb.m aumenta as c4ances de algum nome ser digitado incorretamente.
Prefixo 0 i s 3 r d f t dt a c3 c7 f i9 ix I Ip I9 Tipo de Dados 1arivel 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)


Convenes S7ort !on0 Sem sinal 8onteiro

,bser&e "ue alguns desses %re0i:os so G*i%os com%ostosH. +sto signi0ica "ue eles so
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

@ / 26

utili/ados como %re0i:os %ara outros %re0i:os. , 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 ; 67arvixc ; Inte0er- <<=ndice para um arra5 de caracteres vac#rra5 ; arra5>)??)((@ of 67ar- <<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 . uma &ari&el.
var vc7 ; 67arviSalario ; Inte0er-

aso e:ista necessidade de mais de uma &ari&el do mesmo ti%o3 adota>se a seguinte con&en1o <,b-ect Pascal=D
var vsNomeA vsEnderecoA vs6idade ; Strin0-

Vale a%enas obser&ar "ue3 %ara e0eitos de otimi/a1o de c9digo3 muitas &e/es3 %ode>se a%ro&eitar a mesma &ari&el %ara outra tare0a3 contudo tal %rtica no . recomenda3 %ois redu/ a legibilidade do c9digo>0onte. 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. @.@ ,KOE*,$ E ,FP,5E5*E$ <DELP!+= A nomenclatura a%resentada nesta se1o . &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. , Del%4i . &isual3 orientado a ob-etos e baseado em com%onentes e e&entos. VisualD o %rogramador constr9i as -anelas e dilogos de suas a%lica18es dinamicamente3 minimi/ando a digita1o de c9digoS ,rientado a ,b-etoD Del%4i tra/ todas as caracter6sticas de uma %oderosa linguagem orientada a ob-eto > enca%sulamento3 4eran1a e %olimor0ismo. Kaseado em om%onentesD Del%4i 0ornece "uase duas centenas de com%onentes com os "uais o %rogramador %ode construir suas a%lica18es. E3 %or ser orientado a ob-eto3 %ermite a cria1o de no&os com%onentes a %artir de com%onentes - e:istentes. ada com%onente re%resenta um elemento da a%lica1o3 como um ob-eto de inter0ace de usurio3 um banco de dados3 ou uma 0un1o de sistema. Escol4endo e conectando estes elementos3 &oc constr9i a inter0ace de sua a%lica1o. om%onentes tamb.m %odem %ossuir um mani%ulador <4andle= de e&ento "ue %ermite receber e res%onder a ti%os es%ec60icos de entrada. *amb.m adotaremos uma nomenclatura %adro %ara os com%onentes. Kasicamente os com%onentes %odem ser &isuais ou no>&isuais. ,s com%onentes &isuais %odem ser &istos
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

6 / 26

durante a e:ecu1o da a%lica1o3 en"uanto "ue os com%onentes no>&isuais s9 %odem ser &istos em tem%o de %ro-eto. A nomenclatura . com%osta ordenadamente da seguinte 0ormaD 2ma se"Tncia3 0ormada %or letras maiCsculas3 e:tra6da das iniciais ou da inicial do nome do com%onente base. 5o caso de nomes de com%onentes com%ostos utili/ar a %rimeira letra de cada um dos nomes. A tabela seguinte3 no e:austi&a3 mostra alguns e:em%los da a%lica1o dessa regraD
Sequncia Descrio Botes 33 it tn 3t utton s3 Speed utton !ormu"#rios dm "ataCodule fo 4orm fa 4rame rel 'elatrio %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

Sequncia Descrio Imagens, 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 *+

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


Fr Guer5

01.11.2008
Verso

PO.01
Pgina

1.0

U / 26

;uanto aos itens de menu <com%onentes Fenu+tem=3 seus nomes <%ro%riedade name= de&em estar limitados a 1@ caracteres. 5o menu %rinci%al da a%lica1o3 con0igurar nomes dos itens de menu da seguinte maneiraD
Jnome$itemK ;;* JprefixoKJidentificador$item K JprefixoK ;;* c L r L F Jidentificador$itemK ;;* #L???LMLaL???LzL(L???LN

, %re0i:o GcH identi0ica adastroS GrH identi0ica 'elat9rio e G.H identi0ica consulta. Estes itens de menu esto relacionados aos %adr8es de acesso "ue delimitam o acesso aos recursos dos sistemas3 de&endo %ortando obedecer Ns restri18es a%resentadas. @.6 25+DADE$ E:istem &rias de0ini18es3 sobre o "ue &em a ser uma unidade. 5esta nomenclatura &amos caracteri/ar um m9dulo como sendo algo similar a uma 2nidade <2nit= em ,b-ect Pascal. Para nome>los3 &amos usar o %re0i:o G /H seguido de um nome "ue es%eci0i"ue o ob-eti&o bsico 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. Por e:em%loD as rotinas de mani%ula1o de ar"ui&osD fBpen4ile3 fSeeD4ile3 etc.3 estaro arma/enadas em um m9dulo denominado u4ile. , identi0icador escol4ido %ara com%or -untamente com o %re0i:o o nome do m9dulo de&e ser o nome do elemento bsico "ue o m9dulo mani%ula. , HuH(minIsculo) %recedendo o nome do m9dulo3 segundo con&en1o.

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

8 / 26

Logo a%9s o G/H3 de&e ser descrita a 0un1o do m9dulo3 utili/ando as trs %rimeiras consoantes ou letras da 0un1o do m9dulo. E:em%losD m9dulo de cadastro de clientes . nomeado u6ad8E6lienteS m9dulo de relat9rio de clientes . nomeado u'el8E6liente. m9dulo de %es"uisa de clientes . nomeado u8sF8E6liente. m9dulo de im%orta1o de ar"ui&os . nomeado uImpC4Extrato m9dulo de mo&imenta1o de %edidos . nomeado uCovC48edidos @.U A25VWE$ E P', ED+FE5*,$ A nota1o !Cngara tamb.m . utili/ada %ara nomes de 0un18es/%rocedimentos. E:istem di&ersos GdialetosH encontrados. 2m uso combina um &erbo e um substanti&o %ara descre&er a 0un1o/%rocedimento3 como %or e:em%lo3 6alculaSalario. Este . o dialeto "ue ser adotado a"ui nesta nomenclatura. 5o caso es%ec60ico desta3 o nome da 0un1o/%rocedimento anterior 0icaria assim fc6alculaSalario3 caso 0osse um %rocedimento seria pc6alculaSalario. 5o nosso caso3 utili/aremos sem%re um GfcH ou um G0cH minCsculo %ara identi0icar 0un1o e %rocedimento3 res%ecti&amente. 2se nomes ati&os %ara 0un18es. ,s nomes de 0un18es de&em basear>se em &erbos ati&os3 "ue %odem ser seguidos %or substanti&osD
vi1alor ;* %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 no gere ambigTidades. AssimD
if ( f67ecDBctal (vc"i0ito)) t7en ???

no indica "ual &alor de retorno . true e "ual . 0alse3 en"uanto


if ( fIsBctal (vc"i0ito)) t7en ???

dei:a claro "ue a 0un1o retorna true3 se o argumento . octal e 0alse em caso contrrio. 5o e:iste um Cnico estilo de codi0ica1o3 uma &e/ "ue o gosto %essoal %ode determinar di0erentes estilos. Adotaremos um estilo3 %ara "ue a legibilidade e a manuten1o de %rogramas no se tornem uma tare0a GindigestaH. Para isso &amos adotar algumas normas e regras3 uma delas con4ecidas como G%rettM>%rintingH. @.8 ,FE5*J'+,$

omentrios constituem a %arte mais signi0icati&a da documenta1o interna.Kons comentrios no %odem mel4orar uma m codi0ica1o3 mas comentrios ruins %odem com%rometer seriamente o entendimento de uma boa codi0ica1o.Fuitos %rogramadores caem numa das duas categorias e:tremasD a"ueles "ue escre&em %ouco ou nen4um comentrio3 e a"ueles "ue comentam em demasia. Pre0ira os comentrios no cabe1al4o das rotinas3
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

R / 26

a&isando Ns %essoas o "ue ela 0a/3 e %ossi&elmente P,' ;2E ela 0a/ isso. , taman4o do comentrio de&e assumir %osi1o intermediria3 no m:imo ? lin4as3 mas "ue descre&a bem a o%era1o reali/ada. uidadoD no en0ati/e o 9b&io3 no contradiga o c9digo e no comente c9digo ruim3 reescre&a>o. 525 A tente e:%licar ,F, o seu c9digo 0unciona em um comentrioD . 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 comentrios %ara noti0icar ou a&isar sobre algo %articularmente interessante <ou 0eio=3 mas tente e&itar e:cessos. I im%ortante obser&ar "ue os comentrios no de&em re%etir a codi0ica1o3 mas e:%lic> la e au:ili>la. +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. 2m outro item a ser lembrado3 e "ue com 0re"Tncia . es"uecido3 . de "ue os comentrios e a codi0ica1o de&em estar coerentes entre si. $e 0or 0eita uma mudan1a na codi0ica1o3 de&emos nos assegurar de "ue tal mudan1a re0lita>se nos comentrios relacionados. Para os comentrios nos c9digos elaborados so adotadas as seguintes regrasD 1 # , comentrio de&e ser sem%re antes do c9digo. E:em%loD
Q1erificao da existRncia do 4uncionrio na ta3ela SSSSH cdi0o ???

2 # Entre o c9digo e o comentrio de&e e:istir uma lin4a em branco.


Q1erificao da existRncia do 4uncionrio na ta3ela SSSSH () lin7a em 3ranco) cdi0o ???

? # , comentrio de&e ser alin4ado N es"uerda da margem de codi0ica1o na tela. E:em%loD


Q1erificao da existRncia de funcionrio na ta3ela o%$4uncionarioA e retorno do nome do mesmo 7d7d7d7d7d7d7 d7d7d7d7d7d7d7d7d7d7d77dH

E # ,bser&ar o taman4o Ctil da tela3 ou se-a3 no ultra%assar %ara outra tela o comentrio3 obrigando o obser&ador a rolar a tela %ara &isuali/ar uma lin4a. 5ormalmente nos editores de c9digo este limite 0ica entre 60 e 80 caracteres. @ # ;uando . 0eita altera1o em %rogramas/manuten1o es%eci0icar nome do autor da mudan1a3 data e 4ora e3 se necessrio3 c9digo antigo no cor%o do comentrio. @.R AKEVAL!,$

5o in6cio de cada unidade inserir um cabe1al4o es%eci0icando os seguintes itensD 2nidadeS AutorS Data de ria1oS Aun1oS

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


E:em%loD

01.11.2008
Verso

PO.01
Pgina

1.0

10 / 26

T-------------------------------------------------------------------------------&nidade ; uImp'sp6andidato?pas "ata 6riao; (,<(U<.(() #utor ; 4a3io #lexandre Span7ol "escrio ; &nidade responsvel pela importao das respostas dos candidatos 0eradas pela leitora tica em arFuivo texto? ---------------------------------------------------------------------------------V

omentrio %ara 0un18es e %rocedimentosD


T-------------------------------------------------------------------------------"ata 6riao; (,<(U<.(() #utor ; 4a3io #lexandre Span7ol "escrio ; &nidade responsvel pela importao 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 modi0ica1o3 data em "ue ela ocorre e a descri1o da altera1o. @.10 A,'FA*AVX, 5a 0ormata1o do c9digo>0onte3 tamb.m ser seguida a abordagem %adro denominada G%rettM%rintingH. $ua regra . sim%lesD cada &e/ "ue &oc %recisar escre&er uma instru1o com%osta3 a&ance>a 2 es%a1os %ara direita do restante da instru1o atual. 2ma instru1o com%osta anin4ada . a&an1ada E es%a1os3 e assim %or diante. Por e:em%lo3 na linguagem PascalD
if ??? t7en 3e0in if ??? t7en instruo)instruo.end-

2m 0ormato recuado semel4ante 0re"Tentemente . 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 ; strin0vrSalario ; realvi"ia ; inte0er-

,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. , alin4amento de&e ser 0eito %elo maior identi0icador3 no caso anterior vrSalario. , delimitador de in6cio de bloco de&e come1ar na mesma lin4a da instru1o3 e de 0im de&e estar alin4ado com o in6cio da mesma. Por e:em%loD
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


If (???) t7en 3e0in ??? end-

01.11.2008
Verso

PO.01
Pgina

1.0

11 / 26

Para o comando de atribui1o &amos adotar a seguinte nota1oD 2m es%a1o em branco de%ois do identi0icador3 o comando de atribui1o3 um es%a1o entre ele e o outro identi0icador ou o%erador. Por e:em%loD
vix ;* vi5vix ;* vi5 W )(-

*odas as 0un18es e %rocedimentos3 "uando da sua im%lementa1o de&em come1ar na coluna 1 da tela. Al.m disso3 de&e 4a&er um es%a1o em branco entre os %arnteses da 0un1o e delimitador de in6cio de bloco. E:em%lo em ,b-ect>PascalD
function fStoX (?????A?????); inte0ervar O? 3e0in O end-

,s limites de tela es%eci0icados %ara comentrios em c9digo tamb.m de&em ser seguidos. @.11 ,'E$ E A,5*E$ 2tili/ar as seguintes recomenda18esD Aormulrio <Aorms=D 0undo branco total. '9tulos <Labels=D Aonte Arial3 taman4o 8 e cor %reta. am%os de edi1o <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@=. o ;uando no esti&er em 0ocoD 0undo branco e 0onte *a4oma3 taman4o 8 da cor a/ul>marin4o <')K 0303128=. o ;uando desabilitadoD 0undo cin/a claro <')K 2E?32E?32E?= e 0onte *a4oma normal3 taman4o 8 e cor cin/a m.dio <')K 1@U31@U3161=.

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


1. ESTRUTUR" (O SISTEM" 6.1 E$*'2*2'A DE FE52$

01.11.2008
Verso

PO.01
Pgina

1.0

12 / 26

,s r9tulos dos itens do menu %rinci%al de&em ser coerentes com as 0un18es desem%en4adas no sistema. Por tal moti&o3 tais itens so bastante &ari&eis3 contudo geralmente esto di&ididos em adastro3 onsultas3 'elat9rios e A-uda. A organi/a1o dentro de cada item do menu %rinci%al de&e agru%ar %or 0un18es/ ati&idades correlacionadas os subitens. , %osicionamento dentro de cada agru%amento <ordem= de&e ser a 0re"Tncia de sua utili/a1o3 assim itens utili/ados mais 0re"Tentemente %recedem os itens menos acessados. , %rimeiro item do menu %rinci%al de&e conter como sua Cltima o%1o o item $air3 "ue 0inali/a o a%licati&o. Esse item de&e res%onder N combina1o de teclas Y *'LZY$Z como tecla de atal4o. 6.2 *E LA$ DE A*AL!, As teclas de atal4o seguem o %adro da inter0ace do F$>PindoQs. 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. Esse %rocedimento . &lido %ara itens de menu3 bot8es ou cam%os de edi1o. Por con&en1o3 a tecla sublin4ada ser a %rimeira letra do identi0icador ou outra "ue ten4a seu uso - %adroni/ado nas a%lica18es F$>PindoQs. Algumas 0uncionalidades dos a%licati&os de&ero ser acess6&eis %elo %ressionamento de determinadas teclas3 denominadas 4ot>(eMs. 5as -anelas de edi1o3 as 4ot>(eMs de0inidas soD
+ot,-e. Esc 4) 4. 4, 4U 4/ 4[ 6%'! W 8 !uno 4ec7a a Yanela ativa Exi3e a documentao on-line da aplicao Inicia um novo re0istro na tela Salva as alteraZes atuais #ltera o re0istro selecionado "esfaz as alteraZes no re0istro Exclui o re0istro atual Imprime a lista de re0istro ativa

6.? 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. Essa -anela no de&e %ermitir "ue o usurio e0etue o%era18es "ue a redimensione ou a re%osicione de 0orma arbitrria. 5a barra de t6tulo da -anela %rinci%al <ca%tion bar=3 a%enas os bot8es minimi/ar e 0ec4ar de&em estar 4abilitados. omo dito3 na %arte in0erior da -anela encontra>se a barra de status3 e:ibindo algumas in0orma18es do ambiente de o%era1oD A data atual do sistema o%eracionalS A 4ora atual do sistema o%eracionalS , estado das teclas AP$ L, \3 52F L, \ e +5$E'*. ,s indicadores AP$3
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

1? / 26

52F e +5$ estaro ati&os caso a tecla corres%ondente este-a ligada ou inati&os caso a tecla corres%ondente este-a desligada no momentoS , banco de dados no "ual o sistema est conectadoS A identi0ica1o do com%utador no "ual a base de dados locali/a>seS A identi0ica1o do usurio "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 *+

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

1E / 26

2. ESTRUTUR" (E C#"SSES U.1 5,FE5 LA*2'A$ A nomenclatura "ue de&er ser utili/ada %ara a cria1o de unidades contendo regras de neg9cios ser con0orme as es%eci0ica18es a seguirD Si3ta4e U3it5 cl ] Ysigla do m9duloZ ] Ynome da classeZ E:.D cl$)2suarios Si3ta4e C6ass'ameD * ] Ysigla do m9duloZ ] Ynome da classeZ E:.D *$)2suarios U.2 !E'A5VA *odas as classes de&em 4erdar de G*PersistenciaH. Esta %or sua &e/3 tem as 0un18es necessrias %ara a comunica1o com o banco de dados. U.? A$$, +AVWE$ As classes "ue ti&erem uma rela1o %or associa1o ou agrega1o3 de&ero 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 *+

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

1@ / 26

9. ESTRUTUR" (E *ORMU#RIOS 8.1 DEF,F+5AVX, A nomenclatura %adro %ara denominar 0ormulrios de&er seguir a regra tanto %ara o nome da GunitH3 "uanto %ara a %ro%riedade G5ameH dos 0ormulrios. Si3ta4e U3it5 u ] Yti%o 0ormulrioZ ] Ysigla m9duloZ ] Ynome do 0ormulrioZ E:D u ad$)2suarios Si3ta4e 'ame5 0o ] Yti%o 0ormulrioZ ] Ysigla m9duloZ ] Ynome do 0ormulrioZ E:.D 0o ad$)2suarios 8.2 AFP,$ ,K'+)A*^'+,$

,s cam%os obrigat9rio nas inter0aces %ara o usurio 0inal3 de&ero estar indicados com um asterisco <_= a es"uerda do r9tulo do cam%o. Assim a 0un1o fcRe./eridos:; locali/ada no 0ormulrio mestre foMestre ir &alidar a entrada destes cam%os "ue necessitam ser %reenc4idos %elo usurio. 8.? L+FPE`A D,$ AFP,$ Para reali/ar a lim%e/a dos cam%os automaticamente . necessrio %reenc4er a %ro%riedade G*agH dos cam%os. ,s cam%os "ue %ossu6rem &alor >1 na %ro%riedade *ag no so lim%ados. I %oss6&el de0inir gru%os de cam%os a serem lim%os "uando necessrio3 sim%lesmente de0inindo as tags com o mesmo &alor. 8.E ,F25+ AVX, E5*'E A,'F2LJ'+,$ E LA$$E$

Procedime3to 0c*ormToC6ass5 Este %rocedimento alimenta os atributos da classe com os &alores dos cam%os do 0ormulrio. Em um Cnico 0ormulrio %ode ser necessrio im%lementar mais de um Aorm*o lass. , nome deste %rocedimento obedece a seguinte sinta:eD Si3ta4e5 %cAorm*o lass ] Ynome classeZ Procedime3to 0cC6assTo*orm5 Este %rocedimento alimenta os cam%os do 0ormulrio com os &alores dos atributos da classe. Em um Cnico 0ormulrio %ode ser necessrio im%lementar mais de um lass*oAorm. , 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. ;uanto ao conteCdo3 os r9tulos de cam%os de edi1o cu-o
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

16 / 26

%reenc4imento . obrigat9rio de&em a%resentar um asterisco <_= %recedendo a descri1o. *endo um cam%o de edi1o "ue se-a 4a&e Primria <%rimarM (eM= recebido 0oco3 no %ode ser %ermitido o %rosseguimento de digita1o a menos "ue o usurio in0orme um &alor %ara tal cam%o. A,'F2LJ'+, F,DEL, # F,D, PE$;2+$A

*odos os 0ormulrios "ue mani%ulam registros em massa de&ero %ossuir em sua lateral es"uerda contendo os bot8es de 'a<egao "ue so as o%era18es e:ecutadas sobre os registros3 , gru%o de comando G"=es H somente de&er ser e:ibido caso e:ista o%era18es de comandos %ertinentes a cada 0ormulrio em es%ec60ico. Por e:em%lo3 numa tela de cadastro de %edidos3 este 0ormulrio de&er ter uma a1o denominada GA%ro&ar %edidoH3 ou ento G ancelar %edidoH. Ve-a a seguir a de0ini1o dos bot8es e:istentes %ara na&ega1oD
Se6ecio3arD ca%tura o<s= registro<s= selecionado<s= %ara atribuir em uma outra inter0ace. Co3s/6tarD &isuali/a os dados o registro com maiores detal4es. 'o<oD Adiciona um no&o registro na lista de cadastro a%resentada.
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

1U / 26

Sa6<arD on0irma a o%era1o atual3 sal&ando as altera18es/inclus8es e0etuadas ou iniciando um %rocessamento. "6terarD abre o cadastro com os cam%os necessrios %ara a atuali/a1o do registro. Ca3ce6arD Anula a o%era1o atual3 no e0etuando "ual"uer altera1o/incluso. E4c6/irD 'emo&e o registro "ue esti&er em edi1o no momento. $em%re de&er ser a%resentada uma cai:a de dilogo solicitando uma con0irma1o do usurio %ara e0eti&ar a transa1o de e:cluso. C6o3arD reali/a uma c9%ia dos dados do registro selecionado %ara 0acilitar a digita1o e a%enas algumas altera18es. Im0rimirD en&ia %ara a im%ressora os registros e:ibidos na lista de cadastro. E40ortarD este comando ser utili/ado %ara e:%ortar em uma %lanil4a E:cel somente os dados "ue esto listados. "3teriorD seleciona os dados do registro anterior %ara &isuali/a1o. Pr>4imo5 seleciona os dados do %r9:imo registro %ara &isuali/a1o. Pes./isarD A%resenta a -anela de %es"uisa3 0ornecendo ao usurio uma maneira de locali/ar registros - inclusos na base de dados. A -anela de %es"uisa . a%resentada mais adiante.

A,'F2LJ'+, F,DEL, # F,D, ED+VX,

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


?. RE#"T@RIOS

01.11.2008
Verso

PO.01
Pgina

1.0

18 / 26

,s relat9rios3 N e:ce1o de relat9rios %ara documentos com laMout %r.>determinado3 de&em %ossuir um cabe1al4o contendo a identi0ica1o do sistema3 o t6tulo do relat9rio3 a %gina atual3 o nCmero total de %ginas e a data/4ora de gera1o do relat9rio. , cor%o do relat9rio . &ari&el e de%endente do ti%o de relat9rio a ser im%resso. ;uando a o%1o de relat9rio 0or acionada3 de&e ser e:ibida a -anela de %re&ieQ %adro3 con0orme mostrado na 0igura seguinte. A -anela de %re&ieQ de&e 0ornecer al.m da &isuali/a1o as %ossibilidades de im%resso e e:%orta1o do relat9rio %ara 0ormatos comumente utili/ados como '*A3 PDA3 KFP3 OP) e !*FL.

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 tm as seguintes 0un18esD E:ibe a %rimeira %gina do relat9rio solicitado 'etorna uma %gina E:ibe o nCmero da %gina atual. +n0ormado um nCmero de %gina nesse cam%o de edi1o e teclando>se JEnterK tal %gina ser e:ibida3 caso ela e:ista. aso um dos
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

1R / 26

controles de mo&imenta1o de %gina se-a utili/ado3 o nCmero de %gina a%resentado nesse cam%o de edi1o re0letir a mudan1a de %gina A&an1a uma %gina E:ibe a Cltima %gina do relat9rio solicitado ontrola o %ercentual de /oom de e:ibi1o. , cam%o de edi1o %ermite a escol4a de um &alor arbitrrio 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 dilogo de im%resso A%resenta a cai:a de dilogo "ue %ermite sal&ar o relat9rio em di&ersos 0ormatosD '*A3 PDA3 BL$3 *B* dentro outros ancela a im%resso 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 *+

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


10. PERSISTA'CI" (E ("(OS

01.11.2008
Verso

PO.01
Pgina

1.0

20 / 26

As tabelas3 triggers3 stored %rocedures3 ud0s3 &ieQs modeladas no banco de dados tamb.m recebero uma nomenclatura %adro %ara a elabora1o. $eguindo esta %adroni/a1o3 . %oss6&el assimilar o entendimento de "ual"uer ob-eto criado na base de dados. ,s nomes dos cam%os de&ero %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. Ve-a abai:o os e:em%los de ob-etos "ue de&ero ser nomeados no banco de dadosD 10.1 *AKELA$ ,s nomes das tabelas de&ero estar no $+5)2LA'3 e tamb.m sem%re iniciar com o %re0i:o GTH %ara identi0icarmos "ue . um ob-eto no banco de dados do ti%o *abela. Abai:o segue o esco%o %ara a nomea1o das tabelas con0orme a necessidade
T W Jsi0la mduloK 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 *+

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


10.2 AFP,$ DA$ *AKELA$

01.11.2008
Verso

PO.01
Pgina

1.0

21 / 26

,s nomes de cam%o das tabelas de&ero res%eitar um %re0i:o de nomenclatura con0orme a tabela abai:oD
Ttulo
CODIGO CO#FICI#$%# D&%& D#+C,IC&O -O,&,IO ID#$%IFIC&DO, I0&G#0 I$DIC&DO, $O0# $10#,O P#,C#$%1&; P,&<O >1&$%ID&D# +IG;& %&?& %#?%O %IPO 7&;O,

Sigl
CD CO D% D+ -, ID I0 FG $0 $, PC P< >% +G %? 00 %P 7;

D!"#$i%&o
Forma de identificao de um objeto ou de um indivduo. Designa dados cuja origem e prime uma representao do seu conte!do atrav"s de algum tipo de codificao. Parte num"rica em um produto de fatores num"ricos. Ponto no tempo em 'dia( m)s( ano* ou 'm)s( ano*. Conjunto de palavras citadas para descrever alguma coisa. Composio de '.ora( minuto( segundo* ou '.ora( minuto*. $!mero atribudo pelo sistema ou pelo D/ para identificar um objeto ou lin.a de uma tabela. 1tili2ado para dados de nature2a Imagem 34P#G( /0P( %IF( GIF( etc.5. 6 um 'flag*. Pode assumir apenas dois valores( true ou false( 7 ou F. $o usar 832ero5 ou 93um5. Palavra3s5 com :ue se designa pessoa ou objeto. Indica ordem ou s"rie. Designa os dados cuja nature2a e prime uma parte proporcional calculada sobre uma :uantidade de cem unidades. %empo determinado. #spao de tempo durante o :ual deve reali2ar=se alguma coisa. $!mero de unidades( :ue determina um conjunto de coisas consideradas como e:uivalentes e suscetveis de aumento e diminuio ,epresentao de palavras por meio de algumas slabas ou letras. ,eunio de letras de uma denominao ou ttulo. ,a2o entre as varia@es de duas grande2as das :uais a primeira " dependente da segunda( geralmente aplicado a um tributo 3imposto( ....5 Conjunto de palavras para informar ou comentar alguma coisa. Classificao de algum objeto ou pessoa O e:uivalente justo em din.eiro 3:ual:uer dado :ue e presse moeda5.

10.? *'+))E'$ ,s nomes das triggers de&ero estar no $+5)2LA'3 e tamb.m sem%re iniciar com o %re0i:o GtrH %ara identi0icarmos "ue . um ob-eto no banco de dados do ti%o *rigger. Abai:o segue o esco%o %ara a nomea1o das tabelas con0orme a necessidade
tr W Jsi0la mduloK W Jnome ta3ela s<prefixo %K W Jao tri00erK

E:em%losD
tr8\8roYeto!o0Insercao tr8\8roYeto!o0#lteracao tr8\8roYeto!o0Exclusao

10.E $*,'ED P', ED2'E$ A nomenclatura desses iniciar com o %re0i:o G 0H %ara identi0icarmos "ue . um ob-eto no banco de dados do ti%o $tored Procedure. Em caso de stored %rocedures "ue so do ti%o relat9rio3 ou se-a3 a%9s a e:ecu1o
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

22 / 26

origina um relat9rio %ronto %ara a 0ormata1o3 ser necessrio acrescentar no %re0i:o %adro o seguinte caracter Gre6H. Abai:o segue o esco%o %ara a nomea1o das store %rocedures con0orme a necessidade
pc W Jsi0la mduloK W Jradical store procedureK W Jnome aoK pcre" W Jnome relatrioK

E:em%losD
pc8\8roYetoExcluir pc8E8essoaInserir pc8E8essoa#lterar pcre"6B alancoCensal pcre"6B!ivro'azao pcre"6B!ivro4inanceiro

10.@ A25 *+,5$ E 2DAs ,s nomes das 0un18es de&ero iniciar com o %re0i:o G fH %ara identi0icarmos "ue . um ob-eto no banco de dados do ti%o Aunction. Ainda no nome da 0un1o . necessrio colocar o ti%o do dado "ue ela retorna3 %ara 0acilitar o entendimento e uso da 0un1o. ,s %re0i:os dos ti%os de dados seguem a norma de declara1o de &ari&eis3 ou se-a3 os %re0i:os usados %ara identi0icar a ti%agem da &ari&el.
fc W /tipo dado0 W Jradical funoK W Jnome funoK

E:em%losD
fc1Is6846N8\()fciB3temSetor()fcsB3tem'azaoSocial()fct1B3tem!ista8essoas()fc1Is4uncionario8E'#E()fcd6alcula%axa()-

10.6 V+EP$ ,s nomes das 0un18es de&ero iniciar com o %re0i:o G <8H %ara identi0icarmos "ue . um ob-eto no banco de dados do ti%o VieQ. Abai:o segue o esco%o %ara a nomea1o das tabelas con0orme a necessidade
v2 W Jsi0la mduloK 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 *+

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas


E:em%losD
v2"6Nota4iscal v2#G6ompra6otacao v28\8roYetos v28\8roYeto%axas v28E8essoas v28\8essoa6ontas

01.11.2008
Verso

PO.01
Pgina

1.0

2? / 26

Em caso de &ieQs "ue so do ti%o relat9rio3 ou se-a3 a%9s a consulta origina dados %ara a 0ormata1o3 ser necessrio acrescentar no %re0i:o %adro o seguinte %re0i:o G re6H.
v2re" W Jsi0la mduloK 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$ ,s nomes das bases de dados <database= de&ero iniciar com o %re0i:o GdbH %ara identi0icarmos "ue . um ob-eto no banco de dados do ti%o DataKase. Abai:o segue o esco%o %ara a nomea1o das tabelas con0orme a necessidadeD
d1 W Jnome da 3ase de dadosK

E:em%losD
d14unpar d14inacon d12N8 d1'E4unpar

Aten1ob Para bases de dados de teste . necessrio colocar um su0i:o Gtm%H no 0inal do noma da base. Ve-a abai:o os e:em%losD
d14unpartmp d14inacontmp d12N8tmp d1'E4unpartmp

10.8 2$2J'+,$ ,s nomes dos usurios criados no banco de dados de&ero com um determinado %re0i:o3 %ois3 %ara cada n6&el de %ermisso o usurio ter um %re0i:o identi0icando o usurio.
Elaborador A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

2E / 26

Abai:o segue o esco%o %ara a nomea1o das tabelas con0orme a necessidadeD


Prefixo d3a uap uac uex ute 34ve" de Permisso #dministradores de anco de "ados &surio de acesso para as aplicaZes &surio com acesso apenas para consultas &surio com acesso externo ou remoto &surio para sistemas de terceiros

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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

Procedimento Operacional
Assunto Vigncia Documento

Regras de Codificao de Sistemas

01.11.2008
Verso

PO.01
Pgina

1.0

2@ / 26

11. CO'C#US%O Por "ue se %reocu%ar com o estilo7 ;uem se im%orta com a 0orma de um %rograma se ele 0unciona bem7 5o . %reciso muito tem%o %ara dei:>lo GbonitoH7 A0inal de contas3 as regras no so arbitrrias7 A res%osta . "ue o c9digo bem escrito . mais 0cil de ler e entender. Ele cont.m menos erros e %ro&a&elmente . menor "ue o c9digo "ue 0oi -ogado sem cuidado e nunca 0oi a%er0ei1oado. 5a correria de terminar os %rogramas %ara atender algum %ra/o . 0cil dei:ar de lado o estilo3 %ara se %reocu%ar com ele mais tarde. Essa %ode ser uma deciso cara. Alguns dos e:em%los da &ida real mostram o "ue %ode dar errado3 se no 0or dada aten1o su0iciente %ara o bom estilo. , c9digo deslei:ado . c9digo ruim # no a%enas estran4o e di06cil de ler3 mas "uase sem%re "uebrado. A %rinci%al obser&a1o . "ue o bom estilo de&e ser uma "uesto de 4bito. $e &oc %ensar no estilo ao escre&er o c9digo3 e se &oc re&isar e mel4orar esse c9digo estaro desen&ol&endo bons 4bitos. De%ois "ue eles se tornarem automticos3 seu subconsciente tomar conta de muitos dos detal4es %ara &oc e3 at. mesmo o c9digo "ue &oc escre&er sob %resso ser mel4or.

Elaborador

A%ro&ador

arlos !enri"ue

alesso # Analista de $istemas

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