Prticas e Padres

Nomeao de Arquivos
Todos os documentos do projeto seguiro um padro de nomenclatura a ser utilizado. Este padro consiste em uma sigla seguida de um nmero de identificao do projeto, antecedendo o nome do documento. A sigla deve conter trs caracteres de tamanho, que so as trs primeiras letras do nome do cliente a quem o projeto se destina. nmero de identificao ! composto por trs d"gitos, que correspondem ao identificador do projeto, onde utilizamos ##$ para o primeiro projeto, ##% para o segundo e assim sucessivamente. &or e'emplo, em nosso projeto, a nomenclatura inicial dos documentos ! () ##$, que so as primeiras letras do nome da empresa, seguido do identificador do projeto. s arquivos relativos * aplicao desenvolvida, sero escritos em ingls, e iro seguir a seguinte conveno de nomenclatura+ nome dos arquivos das classes deve ser o mesmo nome da classe, como MimeConstructor por e'emplo. nome dos Web Forms deve possuir uma ,reve descrio do o,jeto seguido da funcionalidade, al!m de conter o prefi'o -./, como wCompose, wFolders e wFoldersAdd por e'emplo. nome dos Web User Controls ir0 seguir a mesma conveno adotada pelos Web Forms, mas contento o prefi'o -uc/, como ucDataCustomers ou ucShowHistory por e'emplo.

Codificao
A linguagem adotada para codificao da soluo ser0 o (icrosoft 1isual )2 .3ET. As seguintes conven4es sero adotadas para a declarao de fun4es, m!todos e classes da soluo+ Ao nomear um elemento da aplicao, o primeiro caractere deste nome deve ser um caractere alfa,!tico, um d"gito, ou um underscore. Estes nomes devem ser escritos em ingls, utilizando a notao 5ngara e'ceto para atri,utos, e a seguinte conveno deve ser adotada para nomeao+ )omear cada palavra distinta em um nome com uma letra maiscula, como FindLastRecord e RedrawMyForm por e'emplo. )omear cada nome de funo e m!todo com um ver,o, como InitNameArray ou CloseDialog por e'emplo. )omear cada nome de atri,uto utilizando6se a novao Camel Case, como bac groundColor ou te!tAlign por e'emplo.

)omear cada nome de classe e propriedade com um su,stantivo, como por e'emplo "mployeeName ou CarAcessory. )omear nomes de interfaces com o prefi'o -7/, seguido de um su,stantivo ou uma frase com su,stantivo, como IComponent, ou com um adjetivo descrevendo o comportamento da interface, como I#ersistable. 8o use underscore, e use a,revia4es somente se houver necessidade, porque a,revia4es podem causar confuso. )omear cada manipulador de evento com um su,stantivo descrevendo o tipo de evento, seguido do sufi'o -"$entHandler/, como em -Mouse"$entHandler/ por e'emplo. Em nomes de classes de argumentos dos eventos, incluir o sufi'o -"$entArgs/. 9e um evento tiver o conceito de -antes/ ou -depois/, usar um prefi'o no tempo presente ou passado, como em -ControlAdd/ ou -ControlAdded/. &ara termos longos ou freq:entemente usados, use a,revia4es para manter um tamanho razo0vel para os nomes , por e'emplo, -5T(;/, ao inv!s de -5<perte't (ar=up ;anguage/. Em geral, nomes de vari0veis com mais de >% caracteres so dif"ceis de ler em um monitor configurado em ,ai'a resoluo. Ao inv!s disso, tenha certeza que suas a,revia4es so consistentes em toda a aplicao. Alterar a escolha entre -5T(;/ e -5<perte't (ar=up ;anguage/ em um projeto pode causar confuso. Evite de usar os nomes em um espao interno que so os mesmos que nomes em um espao e'terno. Erros sero causados se a vari0vel errada for acessada. ?uando um conflito ocorre entre uma vari0vel e uma palavra chave com o mesmo nome, voc precisa identificar a palavra chave precedendo com a ,i,lioteca de tipos correta. &or e'emplo, se voc possui uma vari0vel chamada Date, voc pode usar internamente a funo Date somente se chamar System.Date.

&ara maiores informa4es so,re )onveno de 3omes, consulte o guia de referncia da linguagem 1isual @asic e 1isual )2 na ,i,lioteca do (983, em ms6 help+AA(9.(983?TB.%##> )T.$#>>Av,cnCAhtmlAvacon1@3amingBules.htm