PADRO PARA CODIFICAO ASP/HTML/JAVASCRIPT/VBSCRIPT/ CGMI Coordenao Geral Modernizao e Informtica

Ministrio do Planejamento Oramento e Gesto

Subsecretaria de Planejamento Oramento e Gesto COORDENAO GERAL DE MODERNIZAO E INFORMTICA

..............................................

PADRO PARA CODIFICAO DESENVOLVIMENTO WEB

..............................................
Responsabilidade Tcnica
CGMI Coordenao Geral de Modernizao e Informtica

24/10/2001

Verso 1.0 / 1 Reviso

PADRO PARA CODIFICAO ASP/HTML/JAVASCRIPT/VBSCRIPT/ CGMI Coordenao Geral Modernizao e Informtica

NDICE

1 INTRODUO .................................................................................................... 2 CONVENES ............................................................................................... 2.1 CONVENES DE NOMENCLATURA ............................................. 2.1.1 NOMENCLATURA DE ARQUIVOS ............................................ 2.1.2 NOMENCLATURA DE VARIVEIS............................................ 2.1.2.1 VARIVEIS PARA EDIO HTML..................................... 2.1.2.2 VARIVEIS VBSCRIPT / JAVASCRIPT.............................. 2.1.2.3 VARIVEIS DE CONEXO COM BANCO DE DADOS ... 2.1.2.4 NOMENCLATURA DE PROCEDIMENTOS E FUNCOES . 2.2 CONVENES DE CODIFICAO ....................................................

2 2 2 2 2 2 3 4 4 4

24/10/2001

Verso 1.0 / 1 Reviso

PADRO PARA CODIFICAO ASP/HTML/JAVASCRIPT/VBSCRIPT/ CGMI Coordenao Geral Modernizao e Informtica

1. INTRODUO Esse documento apresenta recomendaes e regras a serem seguidas pela equipe de implementadores da CGMI durante o desenvolvimento de cdigos fonte para sistemas Web (linguagens ASP, HTML, VBScript e Javascript). O objetivo homogeneizar a codificao desses sistemas, facilitando a manuteno e agilizando futuras alteraes e correes necessrias. Como resultado da aplicao das regras aqui contidas, ter-se- um cdigo inteligvel, salientando simplicidade, clareza, alm de qualidade do software produzido. 2. CONVENES 2.1 CONVENOES DE NOMENCLATURA 2.1.1 NOMENCLATURA DE ARQUIVOS

Arquivos de uso geral a serem includos no cdigo pela diretiva include devem apresentar extenso: - .vbs (para arquivos vbscript); - .js (para arquivos javascript); - .css (para folhas de estilo); - .inc (para arquivos com trecho de cdigo) O nome do arquivo livre, sendo escolhido pelo analista responsvel. Ex.: <!-- #INCLUDE FILE = ../INCLUDE/FUNCOES.VBS -->

2.1.2 NOMENCLATURA DE VARIVEIS 2.1.2.1 Variveis para edio HTML Nomenclatura de variveis para edio HTML que alimentam campos no banco de dados devem possuir nomes iguais aos do banco de dados. Ex. : <input name=PRGCod type=text value=-1> A nomenclatura de formulrios deve seguir o padro: frmNome Ex.: frmIndex
frmAcao

24/10/2001

Verso 1.0 / 1 Reviso

PADRO PARA CODIFICAO ASP/HTML/JAVASCRIPT/VBSCRIPT/ CGMI Coordenao Geral Modernizao e Informtica

Nomenclatura de campos do tipo hidden devem seguir o padro: hNome Ex.: <input type=hidden name=hPRGCod value=-1>

<input type=hidden name=hTipoAcao value=Salva>

Demais objetos HTML devem estar de acordo com o padro: xxxNome, onde o prefixo (xxx) pode ser: div: tbl: chk: rad: opt: ifr: img: para div para tabela para checkbox para radiobutton para select option para iframe para imagem

2.1.2.2 Variveis vbscript / javascript A conveno para nomenclatura de variveis estabelece o seguinte padro: xyyyNome, onde:
-

o o o o

g: l: c: p:

x: Determina o escopo da varivel. Deve ser escrito em letra minscula e assume os seguintes valores: para variveis globais para variveis locais (usadas em funes e procedimentos) para constantes para parmetros de funes e/ou procedimentos
-

y: Determina o tipo de dado da varivel (3 caracteres). Deve ser escrito em letra minscula e assume os valores abaixo relacionados:

o o o o o

bln dat dbl int str

(boleano) (data) (double) (inteiro) (string)

-

Nome: Determina o nome da varivel. A primeira letra de cada palavra deve ser maiscula e as demais, minsculas. No deve conter hfen ou sublinhado (underscore).
gintContador lstrMesExtenso

Ex.:

Excees: A nomenclatura acima especificada pode no ser adotada nas seguintes situaes:
4

24/10/2001

Verso 1.0 / 1 Reviso

PADRO PARA CODIFICAO ASP/HTML/JAVASCRIPT/VBSCRIPT/ CGMI Coordenao Geral Modernizao e Informtica

Em cdigos de sada HTML (fins de otimizao e desempenho); Variveis de loop; Cdigos legados; Componentes incorporados (escritos por terceiros).

Nos casos em que se enquadrarem como excees, o nome da varivel deve estar devidamente documentado na pgina, logo em seguida a sua declarao. 2.1.2.3 Variveis de Acesso a Banco de Dados

Variveis que realizam conexo com o banco de dados devem seguir o padro: cnNomedaConexo, onde NomedaConexao deve ser, preferencialmente, o nome do Banco de Dados. Ex. : cnSIGPLAN
cnPPF

Record Sets preferencialmente devem seguir o padro: rsNomeTabela Ex.: rsPrograma

rsAcao

2.1.2.4 Nomenclatura de procedimentos e funes No h uma notao especfica para nomear funes e procedimentos.

2.2 CONVENES DE CODIFICAO Todos os arquivos .asp devem obrigatoriamente possuir um cabealho, contendo os seguintes tpicos: Nome: Nome do arquivo .asp Verso: Verso do arquivo Objetivo: Linhas contendo objetivo do arquivo .asp Data de criao: Data de criao do arquivo .asp Data de reviso: Data de reviso do arquivo .asp - Tabelas lidas: Nomes das tabelas do banco de dados consultadas no decorrer do arquivo - Tabelas Gravadas: Nomes das tabelas do banco de dados alteradas no decorrer do arquivo Nmero Alterao: Identificador da alterao realizada Data da Alterao: Data da alterao realizada Nome Alterador: Nome de quem realizou a alterao Finalidade: Finalidade da alterao realizada

24/10/2001

Verso 1.0 / 1 Reviso

PADRO PARA CODIFICAO ASP/HTML/JAVASCRIPT/VBSCRIPT/ CGMI Coordenao Geral Modernizao e Informtica

Ex.:

***************************************************************** NOME xxxxxxxx.asp VERSO 0.0 OBJETIVO yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy DATA CRIAO dd/mm/yyyy DATA REVISO dd/mm/yyyy TABELAS LIDAS zzzzzzzzzz TABELAS GRAVADAS kkkkkkkkk wwwwww ----------------- ACOMPANHAMENTO DE ALTERAES ---------------ALTERAO 1 NomeProgramador dd/mm/yyyy FINALIDADE 1 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ALTERAO 2 NomeProgramador dd/mm/yyyy FINALIDADE 2 bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb *****************************************************************

OBS 1 : A alterao efetuada, alm de constar no cabealho, tambm deve estar documentada, na forma de comentrio, no local onde foi realizada, ou seja, o trecho do cdigo que foi alterado deve estar precedido do nmero da alterao referenciada no cabealho. OBS 2 : No h estipulado um nmero mximo de alteraes permitidas por cdigo. Recomenda-se que, ao notar que o cdigo visualmente se tornou sujo, o cabealho seja reformulado. Quanto integrao com o sistema MetaDados: - Sempre que houver troca de verso do arquivo, essa alterao deve ser documentada de forma sucinta no sistema Metadados.

A Tag <Option Explicit> de uso obrigatrio em todos arquivos de extenso .asp, forando o desenvolvedor a declarar todas variveis que sero utilizadas. Essa tag deve ser inserida no incio do arquivo .asp.

Quanto declarao de variveis: Recomenda-se declarar variveis globais no incio do arquivo .asp - Recomenda-se declarar variveis de uso local a funo / procedimento no incio do mesmo - Recomenda-se documentar a utilidade de cada varivel imediatamente aps o comando Dim.

24/10/2001

Verso 1.0 / 1 Reviso

PADRO PARA CODIFICAO ASP/HTML/JAVASCRIPT/VBSCRIPT/ CGMI Coordenao Geral Modernizao e Informtica

Quanto capitalizao de variveis: o Deve-se respeitar caixa alta e baixa na declarao de variveis vbscript e javascript.

QUAISQUER EXCEES S REGRAS PROPOSTAS DEVEM DOCUMENTADAS NO LOCAL ONDE OCORREM E NAO NO CABEALHO.

SER

24/10/2001

Verso 1.0 / 1 Reviso