Anexo 1 - Estandares de Desarrollo Web V1

CLUB RECREACIONAL TUNQUI
Estandares de Desarrollo Web

Sistema de Gestin de Clubes Recreacionales
Mdulo de Matricula en Academias
Fecha: 12/01/2011
PROYECTO: SISTEMA DE GESTIN DE CLUBES RECREACIONALES
MDULO MATRICULA EN ACADEMIAS
Esa!"a#es "e Desa##$%%$ &e'
TALLER DE PROYECTOS 2
PROFESORES:
Villanueva Espinoza, Mara del Rosario
Moreno Molina, oel
SECCIN: EA!"
Est#ndares de Desarrollo WE$ % Matricula de Ac#demias
Fecha: 12/01/2011
(NDICE
1. INTRODUCCIN..................................................................................................................3
1.1 PROPSITO DEL DOCUMENTO................................................................................................3
1.2 ALCANCE.............................................................................................................................. 3
1.3 CONTROL DE VERSIONES......................................................................................................3
2. ESTANDARES DE PLATAFORMA WEB.........................................................................3
2.1 ARQUITECTURA LGICA.......................................................................................................4
2.2 PLATAFORMA HARDWARE / SOFTWARE...............................................................................4
3. ESTANDARES GENERALES Y LINEAMIENTOS..........................................................5
3.1 ESTANDARES DE ACTIVE SERVER PAGES ASP Y ASP.NET.............................................6
3.2 ESTANDARES HTML............................................................................................................
3.3 ESTANDARES DE SEGURIDAD..............................................................................................12
3.4 ESTANDARES DE COMPILACIN..........................................................................................13
4. ESTANDARES DE PROGRAMACIN VISUAL BASIC .NET....................................14
4.1 REGLAS DE PROGRAMACIN..............................................................................................14
4.2 ELEMENTOS DE UN PROYECTO WINDOWS..........................................................................1!
4.3 ELEMENTOS DE UN PROYECTO WE"...................................................................................21
4.4 ESTRUCTURA DE UN PROYECTO WE".................................................................................23
4.# CONVENCIONES DE NOM"RE..............................................................................................24
4.5.1 Distincin de maysculas y minsculas.....................................................................24
4.5.2 Maysculas y minsculas pascal...............................................................................25
4.5.3 Maysculas y minsculas camel................................................................................25
4.5.4 Abreviaturas..............................................................................................................26
4.5.5 Elecciones de palabra...............................................................................................26
4.5.6 Evitar conusin de nombres de tipos........................................................................2!
4.5.! "nstrucciones #enerales de nomenclatura de espacio de nombres $namespace%.......2&
4.5.' "nstrucciones de nomenclatura de modulos y clases.................................................3(
4.5.& "nstrucciones de nomenclatura de interases.............................................................3(
4.5.1( )omenclatura de controles y ormularios...............................................................31
4.5.11 )omenclatura de atributos......................................................................................32
4.5.12 )omenclatura de variables......................................................................................32
4.5.13 )omenclatura de constantes....................................................................................35
4.5.14 )omenclatura de enumeraciones............................................................................35
4.5.15 )omenclatura de campos estaticos.........................................................................35
4.5.16 )omenclatura de parametros..................................................................................35
4.5.1! )omenclatura de metodos* procedimientos y unciones..........................................36
4.5.1' )omenclatura de propiedades.................................................................................3!
4.5.1& )omenclatura de +utinas........................................................................................3'
4.5.2( Mane,o de E-cepciones...........................................................................................3'
5. DOCUMENTACIN...........................................................................................................39
#.1 DESCRIPCIN DE CLASE / MODULO....................................................................................3
#.2 DESCRIPCIN DE PROCEDIMIENTO......................................................................................4$
#.3 COMENTARIOS DENTRO DE LA FUNCIN............................................................................4$
Fecha: 12/01/2011
1) INTRODUCCIN
1)1 P#$*+s,$ "e% "$c-.e!$
El propsito de este documento es describir la plata&orma ' est#ndares tecnol(icos
sobre la )ue se tienen )ue desarrollar ' e*ecutar las aplicaciones +eb basadas en
,erramientas de Microso&t-
1)2 A%ca!ce
Diri(ido a los e)uipos responsables de las Areas de desarrollo-
1)/ C$!#$% "e 0e#s,$!es
E0OLUCION DEL DOCUMENTO
0e#s,+! Fecha A-$# M$",1,ca"$ E2$%-c,+!
!-" "./!"/.!"" David Rubi0os
Matta
1rimera versin de los
est#ndares para desarrollos
+eb
2) ESTANDARES DE PLATAFORMA &EB
Fecha: 12/01/2011
2)1 A#3-,ec-#a L+4,ca
2a ar)uitectura 2(ica de las aplicaciones Web deber# estar basada en la
ar)uitectura de tres capas-
2(ica de 1resentacin
2(ica de 3e(ocio
2(ica de 1ersistencia-
L+4,ca "e P#ese!ac,+!)5 Es la inter&az del usuario a la aplicacin-
3ormalmente esta capa controla la apariencia de la aplicacin ' responde a los
eventos del usuario- 2a inter&az de usuario de una aplicacin +eb ser# siempre
un nave(ador 45E % 5nternet E6plorer 7-! sp. superior8 al )ue lle(an pa(inas
)ue deben contener 9nicamente cdi(o :;M2 <-!, CCS " ' ocasionalmente
cdi(o avaScript "-= para validacin de campos 4&ec,as v#lidas, validacin
tipo de datos, etc-8
En el lado del servidor, la l(ica de presentacin estar# &ormada por el cdi(o
cu'a e*ecucin permita la composicin din#mica de las pa(inas :;M2 )ue
via*aran al cliente- Esto podr# realizarse siempre desarrollando con el est#ndar
AS1 del 5nternet 5n&ormation Server 7-! 455S8
L+4,ca "e Ne4$c,$)5 Representa el n9cleo principal de una aplicacin ' es
donde se realiza el procesamiento espec&ico de la aplicacin utilizando las
re(las del ne(ocio- 1ara ello se ,ar# uso de los componentes de ne(ocio de
C>M? del servicio del mismo nombre )ue provee Windo+s .!!!- Se utilizar#
MS Visual Studio- 3E; 4Visual $asic ' /o Visual C@8- Esta capa se utiliza entre
la capa de presentacin ' de Datos-
L+4,ca "e Da$s)5 Donde est#n ubicados los datos de ne(ocio, es decir la
in&ormacin )ue mane*a la aplicacin para su correcto &uncionamiento- 2a
in&ormacin )uedar# almacenada en una base de datos Microso&t SA2 Server
.!!B- El acceso a la base de datos se realizar# utilizando AD> a travCs de
>2EDD$- 2a l(ica de datos 5nte(racin permite lle(ar a las &uentes de datos
propias de la aplicacin ' a otras e6ternas proporcionadas por otras
aplicaciones ' sistemas de in&ormacin-
Ena $D pertenece a una sola aplicacin, proporcionando esta aplicacin los
servicios de actualizacin ' consulta de datos- >tras aplicaciones usar estos
servicios en vez de realizar acceso directo a estos datos-
En especial ' debido a los problemas de Se(uridad )ue presentan, no se
podr#n utilizar controles ActiveF para el desarrollo de aplicaciones +eb-
2)2 P%aa1$#.a 6a#"7a#e / S$17a#e
Fecha: 12/01/2011
Servidor 53;E2 como :ard+are ' so&t+are b#sicoG
Sistema >perativo GWindo+s .!!= Server
Servidor +eb G5nternet 5n&ormation Server 7-!
Servidor componentes G C>M?
Servidor 1resentacin GAS1F proporcionado por 55S
$ase de Datos G Microso&t SA2 Server .!!B
2en(ua*e Desarrollo GMS Visual Studio - 3E;
:erramienta Dise0o GErd+in,EM2
3ave(ador G5nternet E6plorer B-B sp. superior
Acceso a Datos G AD>
/) ESTANDARES GENERALES Y LINEAMIENTOS
Fecha: 12/01/2011
1ara el desarrollo de aplicaciones en esta plata&orma, se dispondr# de tecnolo(a
Microso&t, de tal &orma )ue para la l(ica de presentacin se dispondr# de
5nternet 5n&ormation Server 7-!, para la l(ica de ne(ocio se dispondr# de C>M?
' para la l(ica de datos de dispondr# de MS SA2 Server .!!!-
Ac,2e Se#2e# Pa4es 8ASP9
Es un componente de 55S % 5nternet 5n&ormation Server, versin 7-! superior,
)ue representa un entorno de scriptin( de servidor )ue puede ser usado para
crear ' e*ecutar aplicaciones interactivas ' dinamicas-
ASP)NET
Es un componente del Microso&t -3et Hrame+orI )ue permite construir, desple(ar
' e*ecutar aplicaciones +eb ' aplicaciones distribuidas-
I!e#!e I!1$#.a,$! Se#2e# 8IIS9
55S 7-!, ser# la plata&orma so&t+are )ue deber# utilizarse para la e*ecucin de la
l(ica de presentacin desarrollada de acuerdo al estandar AS1-
COM:
Ser# la plata&orma so&t+are )ue deber# utilizarse para la e*ecucin de la l(ica de
ne(ocio ' acceso a datos de acuerdo al est#ndar C>M?- 2os componentes C>M?
podr#n ser desarrollados con len(ua*es -3E;
SQL Se#2e# 200;
Ser# la plata&orma so&t+are )ue deber# utilizarse para el almacenamiento '
e*ecucin de la l(ica de datos- El acceso a los datos ser# mediante el est#ndar
AD> .-B
2a tecnolo(a C>M? de&ine un modelo para el desarrollo ' desplie(ue de
componentes reutilizables ' escritos en cual)uier len(ua*e de pro(ramacin- El
entorno C>M? proporciona las ,erramientas necesarias para crear aplicaciones
basadas en ar)uitectura multicapa-
Modelo de Datos-D Mediante la ,erramienta ERW53 se podr# dise0ar el
modelo de datos de una aplicacin )ue usar# SA2 Server .!!B-
MCtodo de Acceso-D Se puede realizar mediante *erar)ua de ob*etos de alto
nivel AD> mediante A15s de ba*o de nivel-
/)1 Esa!"a#es "e Ac,2e Se#2e# Pa4es < ASP = ASP)NET
Fecha: 12/01/2011
N$.'#es "e A#ch,2$s
;odas las pa(inas empezaran con un pre&i*o J6666K se(uido de un alias para la
accin 4 Reporte, Creacin, Consulta, $9s)ueda, etc8 )ue se realiza en la
p#(ina, de lon(itud = caracteres, se(uido de un nombre descriptivo en sin(ular,
las primeras letras deben estar en ma'9sculas-
E*emplosG
66663ue1er&il
6666SolRe)uerimiento
66662isMantenimiento
6666$usEsuario
P#>c,cas a"ec-a"as
Cada AS1 )ue se cree debe incluirse dentro de un mapa o dia(rama del
Site-
Se considera una pr#ctica acertada declarar al inicio de cada AS1 )ue el
contenido ser# bu&&erizado, ' limpiar el bu&&er-
El in(reso de san(ra es obli(atorio- Se considera una tabulacin por cada
indentancin-
2as palabras reservadas se in(resaran en ma'9sculas-
El pro'ecto debe contener una p#(ina con declaracin ' seteo de
constantes (lobales- Esto &acilita el mantenimiento del Site-
Solicitar par#metros JRe)uestK solo una vezG Asi(narlos a una variable-
A pesar )ue el Servidor Web lo ,a(a, todos los ob*etos )ue se creen deben
ser eliminados e6plcitamente-
El uso de arc,ivos include permite reutilizar cdi(o sin necesidad de reD
escribirlo- Sin embar(o se debe ser cuidadoso pues en ocasiones estos
arc,ivos crecen enormemente ,aciendo lenta la per&ormance de las
p#(inas-
;odas las pa(inas deben poseer un mane*ador de erroresG Deben veri&icar
)ue aun se encuentran conectados al Servidor Web ' , antes de enviar el
contenido del bu&&er al cliente, veri&icar )ue el proceso se e&ectu
correctamente-
El empleo de scriptlets es una alternativa viable al uso de ActiveF- Aun)ue
tiene el inconveniente de no encapsular el cdi(o, se evita el problema de
re(istrar el control en la ma)uina del cliente- >tra venta*a es )ue emplea
:;M2 ' Script Cliente incrustado-
55S permite personalizar mensa*es ante situaciones particulares 4cuando el
cliente ,a in(resado una direccin errnea , por e*emplo8- Aprovec,ar esta
venta*a ' personalizar las pa(inas de errores-
Considerar mane*o transaccional de AS1s cuando la situacin lo re)uiera-
El #mbito transaccional, puede, incluso abarcar mas de una AS1-
Fecha: 12/01/2011
Pe#1$#.a!ce
:abilitar el bu&&erizado por Con&i(uracin de ServidorG A pesar )ue el
bu&&erizado ser# ,abilitado por de&ecto en 55S7-! esta opcin se puede
,abilitar manualmente en 55S<-!-G Desde el tab de 1ropiedades del Site
seleccionar el botn de con&i(uracin en el tab de :ome Director'-
Seleccionar la opcin Lenable bu&&erin(L ba*o LApp optionsL-
Eso de >ption E6plicitG Declarar la directiva >ption E6plicit en una AS1
re)uiere )ue todas las variables sean declaradas en la pa(ina antes de ser
empleadas- Esto es recomendable por varios motivos- 2a aplicacin puede
mane*ar el acceso a las variables con ma'or rapidez-, previene un mal
nombramiento de variables ' adicionalmente, la per&ormance en la e*ecucin
de la AS1 se incrementa-
3o ,acer uso de variables de Session- Microso&t recomienda no usar este tipo
de variables, ' usar otras alternativas de desarrollo, pero si es realmente
necesario limitarse a usar m#6imo uno o dos en toda la aplicacin-
Acces$ a Base "e Da$s
1ara el traba*o con recordsetsG :acer re&erencia a los nombres de los campos
de los re(istros )ue se deseen recuperar- 3o emplear posiciones como
re&erenciaMdel tipo rs4!8
;ener especial cuidado con el in(reso de datos de tipo te6to- 2as sentencias
de SA2 )ue re&erencia campos de te6to con comillas simples 4N8 ,an de ser
&ormateados antes de enviar la consulta al servidor-
3o se debe e*ecutar las consultas directamente desde las AS1- Se ,a
comprobado e6perimentalmente una me*or per&ormance cuando las consultas
se e*ecutan (racias a Stored 1rocedures-
Fecha: 12/01/2011
/)2 Esa!"a#es 6TML
N$.'#es "e O'?e$
6663ombre>b*eto
2os primeros tres caracteres son letras min9sculas e identi&ican el tipo de ob*eto,
a saberG
t6t ;e6t
t6a ;e6tArea
rad Radio $utton
c,I C,ecI $utton
btn $otn
cbo Combos simples
lst Combos Multiples
,id :idden
im( 5ma(enes
&rm Horms
i&r 5&rames
A partir del car#cter n9mero cuatro 4<8 se detalla el nombre del ob*eto, toda la
palabra en estilo oracin 4inician con ma'9sculas ' el resto de la palabra en
min9sculas8 ' no tiene un lmite de caracteres establecido, a e6cepcin de los
lmites de la ,erramienta de pro(ramacin- E*emplos de nombres de ob*etos de
este tipo para el aplicativo Consultas >nline sonG t6t3ombreServidor,
,id3umeroRe(istros ' rad5ndicaMarca-
C$.e!a#,$s
OOO Hormulario G de&ault-,tm
OOO Descripcin G 1a(ina inicial por de&ecto
OOO Creado por G David Rubi0os
OOO Modi&icado por G
OOO Hec,a ' ,ora G "!/!./.!"! D ".G!! AM-
Adicionalmente, )ueda a discrecin del desarrollador la inclusin de
comentarios en las porciones de cdi(o )ue considere conveniente- 2os
comentarios en cdi(o deben ser breves ' precisos, 'a )ue se considera )ue el
cdi(o debe autoDdocumentarse por si solo-
Fecha: 12/01/2011
I"e!ac,+! "e c+",4$
1ermite dar ma'or claridad al cdi(o- Se mantendr# el est#ndar de una
tabulacin 4tecla ;A$8 como salto de identacin- 4Considerando el empleo de
Courier 3e+ como &ont, una tabulacin en el entorno de Visual 5nterdev es de <
espacios por de&ecto8-
2a identacin de cdi(o debe re&le*ar el ,ec,o )ue al(unos elementos son
contenidos por otros-
En el e*emplo si(uiente se veri&ica r#pidamente )ueG
El ta( PtdQ es contenido por el ta( PtrQ
El ta( PtrQ es contenido por el ta( PtableQ
E.*%e$ "e h$?as "e es,%$s 8CSS9
Se(9n la World Wide Wide Consortium 4W=C8, una manera de traba*ar la +eb
de manera adecuada es separando presentacin de contenido-
2as ,o*as de estilo CSS 4cascadin( st'les,eets8 son un mecanismo simple
para controlar el estilo de un documento Web sin comprometer su estructura- Al
e&ectuar esta separacin entre dise0o visual de elementos 4&onts, colores,
m#r(enes, etc-8 de la estructura l(ica de la Web los dise0adores obtienenG
Separacin ordenada de estilo / estructura
Ma'or velocidad de descar(a-
Ma'or &acilidad de mantenimiento-
1osibilidad de control del la'out de mas de una p#(ina
2a presentacin debe ser controlada a travCs de CSS-
2a &orma de llamar al arc,ivo e6terno CSS es la si(uienteG
PlinI relRLst'les,eetL ,re&RLMi:o*aDeEstilo-cssLQ en todas las pa(inas +eb en
la parte del P,eadQ
Pe#1$#.a!ce
El desarrollador debe tener siempre en mente )ue el cdi(o en cliente ser#
descar(ado por el nave(ador- 1or tanto, para incrementar la per&ormance el
cdi(o cliente deber# ser lo mas sintCtico posible- Mientras mas reducido sea el
tama0o de la p#(ina muc,o me*or-
Fecha: 12/01/2011
Con ese ob*eto, se proponeG
Reduccin en tama0o de im#(enes
Comentarios escuetos- 4Ver apartado JComentariosK8
Emplear ,o*as de estilos 4Ver apartado J:o*as de estilosK8
Emplear caracteres especiales 9nicamente cuando sea necesario 4Ver
apartado JCaracteres especialesK8
Reducir indentaciones 4Visual 5nterDev permite personalizar la cantidad de
espacios8-
Evitar cdi(o redundante
2os valores )ue son tomados por de&ecto por los nave(adores, no se ,ace
necesario incluirlos
Emplear ta(s reducidos- 1or e*emploG
Emplear el ta( P$Q ' no PS;R>3GQ para &ormatear el te6to en ne(ritas-
Emplear el ta( P5Q ' no PEMQ para &ormatear el te6to en it#licas-
Emplear el ta( PCE3;ERQ ' no PD5V A25G3RcenterQ para centrar un
elemento-
Emplear el ta( P$5GQ ' no PH>3; S5SERL?"LQ para ,acer un punto m#s
(rande un te6to-
Emplear el ta( PSMA22Q ' no PH>3; S5SERLD"LQ para ,acer un punto mas
pe)ue0o un te6to-
Emplear el ta( P;;Q ' no PC>DEQ o PSAM1Q para ,acer monoespaciado
un te6to-
Eliminar los ta(s PME;AQ insertados innecesariamente por los editores- 2os
elementos ME;A son libres a criterio del +ebmaster, sin embar(o se
recomienda no usar ME;A para re&rescar autom#ticamente una p#(ina-
Siempre de&inir un ttulo para la p#(ina-
Fecha: 12/01/2011
/)/ Esa!"a#es "e Se4-#,"a"
;odo desarrollo en un sistema de in&ormacin debe contemplar el acceso
mediante el uso de una cuenta de usuario ' una clave de acceso-
;odo desarrollo debe mane*ar un modulo de Se(uridad-
El sistema debe contar con la &acilidad de cambio &orzado de la clave de acceso
cada =! das-
El usuario debe ser &orzado por el sistema a cambiar su clave de acceso antes
de poder iniciar su primera sesin para el sistema-
2os desarrolladores de Sistemas de Aplicacin deben en lo posible dele(ar el
Control de Acceso al Sistema >perativo- 2os desarrolladores no deben construir
mecanismos separados para almacenar pass+ords o 5denti&icacin de Esuarios-
En &orma similar, los desarrolladores no deben construir o instalar otros
mecanismos para identi&icar o autenticar la identidad del Esuario sin el permiso
de la e&atura de Se(uridad ' ;estin(-
El aplicativo debe (enerar un lo( )ue permita las si(uientes consultasG
Consultar &ec,a de creacin de la cuenta-
Consulta de >pciones asi(nadas a los usuariosG
Esuarios )ue tienen asi(nada determinada per&ilDopcinDo pro(rama
>pciones o per&iles )ue tiene asi(nado un usuario-
2o( de trails de auditoria de acceso de usuarios a las opciones
/pro(ramas crticos-
Consultar listado de todos los usuarios del sistema )ue indi)ueG
Cdi(o 4userTid8
Descripcin 43ombre ' Datos del usuario8
Hec,a de creacin de la cuenta ' usuario )ue la cre
Estado del usuario 4activo8, 4des,abilitado8, ultima &ec,a de acceso-
2a clave de acceso nunca debe estar incorporada en las lneas de cdi(os de
los aplicativos desarrollados-
3in(9n desarrollador debe mantener una cuenta en el aplicativo cuando Cste
pase a produccin-
En todos los sistemas desarrollados por DGG se debe mantener un arc,ivo
,istrico encriptado de las claves de acceso previas- Este Arc,ivo ,istrico debe
ser empleado para prevenir )ue los usuarios reutilicen las claves de acceso
anteriores- Este arc,ivo ,istrico debe contener al menos las 9ltimas seis 478
claves para cada cuenta, adem#s no debe permitir )ue la clave de acceso sea
i(ual al nombre de la cuenta-
Fecha: 12/01/2011
/)@ Esa!"a#es "e C$.*,%ac,+!
;odo 1ara la instalacin de componentes en el MRE se deben tener en cuenta
como opciones de compilacin las si(uientes consideracionesG
3ombre de 1ro'ecto idCntico al 3ombre de Componente 4librera
(enerada8-
Enattended E6ecution 4E*ecucin desatendida8-
Retain 5n Memor' 4Retenido en memoria8-
$inar' Compatibilit' 4Compatibilidad $inaria8-
D;C Service Started 4Servicio Coordinador de ;ransacciones de Datos
5niciado8
A)uellos componentes )ue no sean compilados con estas consideraciones '
ba*o estas condiciones podran causar serios problemas de memoria en el
servidor as como la caida del servicio (eneral de componentes-
Fecha: 12/01/2011
@) ESTANDARES DE PROGRAMACIN 0ISUAL BASIC )NET
@)1 Re4%as "e P#$4#a.ac,+!
I"e!,1,ca"$#es
2os identi&icadores representan los ob*etos de un pro(rama 4constantes, variables,
tipos de datos, procedimientos, &unciones, pro(ramas, campos de re(istros, etc-8- En
identi&icador es una secuencia de caracteres )ue puede ser de cual)uier lon(itud,
pero slo .BB primeros caracteres son si(ni&icativos-
En identi&icador se caracteriza por estas re(lasG
"- Debe comenzar con una letra 4A a S, ma'9sculas o min9sculas8 ' no puede
contener blancos-
.- 2etras, d(itos ' caracteres subra'ados 4T8 est#n permitidos despuCs del primer
car#cter e6cepto como 9ltimo car#cter-
=- 3o se puede utilizar una palabra reservada como identi&icador-
<- 2os caracteres U, V, W, @, X, Y solo pueden ser usados al &inal del
identi&icador4variable8 para indicar el tipo de datos )ue almacenar# dic,a variable-
Sc#,*s "e 0B
Antes de todo, se debe precisar )ue 3> es recomendado utilizar V$Script, pues
no es aceptado por muc,os nave(adores-
Dentro de la eti)ueta :;M2 PSCR51;Q ' antes del cdi(o V$Script propiamente
dic,o, aparece el smbolo del comentario :;M2 PWDD- Esto se ,ace para evitar
)ue los nave(adores )ue no son capaces de interpretar el script muestren el
cdi(o-
E*emploG
PSCR51; 2A3GEAGERLV$ScriptLQ
PWDD
Document-Write4LEsto ,a sido escrito por V$ScriptL8
DDQ
P/SCR51;Q
Fecha: 12/01/2011
2os scripts pueden escribirse tanto en la P:EADQ como en el P$>DZQ de la p#(ina-
1or claridad a la ,ora de revisar el cdi(o, es pre&erible escribir todas las secuencias
de comandos al principio de la p#(ina en la P:EADQ, aun)ue esto depender# de las
necesidades del pro(rama-
Se utiliza al escribir AS1, es el truncamiento de lneas- 1or e*emplo, si tienes )ue
escribir una lnea de comandos o strin(s )ue es mu' lar(a, para evitar )ue el editor
ten(a )ue ,acer scroll 4desplazarse8 por la derec,a, cosa )ue di&iculta despuCs la
lectura ' revisin del cdi(o escrito, se puede utilizar el car#cter de subra'ado para
indicar a AS1 )ue la lnea )ue viene *usto deba*o debe ser considerada como una
misma lnea- As
PU
Response-Write4LEste es un strin( de muestra )ue ,a' )ue concatener con otro,
pero es demasiado
lar(o ' L V T
Lrecurriremos al car#cter T para )ue resulte m#s le(ibleL8
UQ
Recuerda )ue entre la primera ' la se(unda lnea no puede ,aber nin(una en
blanco, ni tampoco un comentario[ tienen )ue estar *untas- Se puede utilizar el
truncamiento cuantas veces sea necesario- Como 'a ,abr#s visto, siempre )ue
se utilizan strin(s 4cadenas de te6to8, ,a' )ue escribirlas entre comillas dobles
4L8- Si se trata de n9meros no ,a' )ue escribirlos entrecomillados, ' si se trata de
&ec,as, se escriben entre smbolos @- En el si(uiente e*emplo se representan un
strin(, un n9mero ' una &ec,a, por ese ordenG
PU
Response-Write4 LEsto es un te6toL 8
Response-Write4 B! 8
UQ
Z a propsito de las &ec,as, en AS1 ' V$Script, el 9nico &ormato reconocido es
53G2ESDES;AD>S E35D>S, sin tener en cuenta la con&i(uracin re(ional del
usuario- Es decir, el &ormato )ue se reconoce es mm/dd/aaaa- As en el e*emplo
de arriba, tenemos el da .\ de Hebrero de .!!!- 2o )ue obli(a a realizar las
conversiones necesarias para el &ormato europeo de dd/mm/aaaa-
R-as
2as rutas deber#n ser relativas ' no absolutas, en caso se utilice el absoluto
deber# tener cuidado en su escritura, ' utilizar el ob*eto de servidor del len(ua*e-
+indo+-open4L,ttpG//L V Server-Mac,ine3ame V L/L V Re)uest-Application1at,
V L/&rm2o(out-asp6K8
Fecha: 12/01/2011
F,che#$s "e I!c%-s,+!
Solo debe ser usado en caso necesario- Se deber# de&inir para casos de
reutilizacin de cdi(o los &ic,eros de inclusin, en este caso deber# contener la
ma'or cantidad de &unciones comunes de todo el con*unto de p#(inas )ue
pertenecen al pro'ecto-
2a llamada a un include se escribe como un comentario de :;M2- Esta es la
sinta6is de una include virtual en el e*emplo anteriorG
PUX 2A3GEAGERLV$ScriptL UQ
P:;M2Q
P:EADQP;5;2EQ1rueba de AS1P/;5;2EQP/:EADQ
P$>DZQ
PWDD@include virtualRL/miapliacacion/includes/lo(o-incLDDQ
$ienvenidos al AS1- Son las PU Response-Write4 ;ime48 8 UQ
P/$>DZQ
P/:;M2Q
0a%,"ac,+! "e 0e#s,+! "e% Na2e4a"$#
Se debe preparar la p#(ina para )ue &uncione de manera correcta en cual)uier
nave(ador 45nternet E6plorer, Hire&o6, >pera, etc8 ' en cual)uier versin
4obviamente versiones mu' anti(uas no8-
Deber# e6istir la validacin del nave(ador en uso donde el aplicativo se
e*ecutara per&ectamente, en caso contrario deber# arro*ar los mensa*es
apropiados-
0a%,"ac,+! "e Ses,$!es
El lo(eo a una p#(ina siempre debe ser a travCs de consulta a base de datos, no
puede usarse una cuenta de usuario in(resada como cdi(o duro-
E6istir# la validacin correspondiente para )ue el usuario no pueda in(resar sin
,aberse lo(ueado en aplicaciones )ue interact9en con $ase de Datos en su
de&ecto la sesin ,a'a e6pirado- En cual)uiera de estos casos deber# enviarlo a
la p#(ina de lo(ueo para el seteo correspondiente de la clave ' contrase0a
asi(nada-
Sa%,"a "e S,se.a
Fecha: 12/01/2011
En caso se abandone el sistema deber# eliminarse toda variable de Sessin
utilizada en el sistema- 1ara toda salida del sistema deber# utilizarse el metodo
RemoveAll del ob*eto Session-
Session-RemoveAll
En este caso se recomienda, considerar un arc,ivo include para actividad-
PWDD@include &ileRLinclude/validaTSesionTActiva-aspLDDQ
E%,.,!ac,+! "e% cachA "e Na2e4a"$#
;oda p#(ina deber# contener la sentencia de eliminacin del cac,C del
nave(adorG
PU
Response-$u&&er R ;rue
Response-Clear
Response-E6pires R !
UQ
2a propiedad JE6piresK del ob*eto Response indica el n9mero de minutos )ue
deben transcurrir antes de )ue la copia de la respuesta en las cac,es del
nave(ador e6pire 4sea eliminada8- Si no se invoca esta propiedad, el tiempo de
e6piracin ser# el )ue ten(a con&i(urado el nave(ador por de&ecto-
N$.e!c%a-#a "e C$.*$!e!es
2os componentes del pro'ecto deber#n tener la si(uiente sinta6isG
Ppre&i*oTpro'ectoQTPnombreTC>MQ-D22
C$!eB,$!es a 'ase "e "a$s
;oda cone6in a las $ase de datos deber#n utilizar el driver nativo del
mane*ador de $ase de Datos se(9n le corresponda-
Antes de la cone6in deber# ser de&inidos los ob*etos connection, recordset,
command, etc-
Set connSis R Server-Create>b*ect4LAD>D$-ConnectionL8
Set rs1ersonal R Server-Create>b*ect4LAD>D$-RecordSetL8
Fecha: 12/01/2011
;oda las cone6in a la base de datos deber#n estar en componentes, no se
permitir# cone6iones )ue se encuentren en p#(inas del pro'ecto-
E!c#,*ac,+! "e Daa
2a cone6iones a la base de datos )ue se encuentren en arc,ivos de
con&i(uracin deber#n estar encriptadas, no se permitir# )ue dic,os te6tos sean
ledos visualmente-
Se!e!c,as SQL
3o se permitir# sentencias SA2 dentro de las p#(inas AS1 ni AS1-3E;[ toda
sentencia SA2 de seleccin, eliminacin ' actualizacin deber# ser in(resada en
un procedimiento almacenado-
O#as C$!s,"e#ac,$!es
1ara la con&i(uracin se debe utilizar un arc,ivo -ini-
Es conveniente )ue al lo(earse llamando a un componente, se *ale la
cadena de cone6in usando el ob*eto Session, siempre llamando a un
mCtodo del componente-
2a creacin ' con&i(uracin de carpetas en un aplicativo debe ser
revisada ' debe ser parametrizada llamando a AS1-
Evitar todo cdi(o duro, nada debe ser de&inido en el aplicativo, sino
car(ado de la base de datos a travCs de un mCtodo de un componente-
Evite el uso de 55H pues ,ace )ue se revise ambos casos, a di&erencia de
5H E2SE )ue solo revisa a)uella )ue cumple con la condicin-
3o declare variables o constantes )ue no se usan en todo el aplicativo-
;ener bien presente la di&erencia entre crear un procedimiento de una
&uncin
@)2 E%e.e!$s "e -! P#$=ec$ &,!"$7s
E%e.e!$ P#$=ec$ EBe!s,+! A#ch,2$
P#$*+s,$ e%e.e!$
P#$=ec$
Hormulario Windo+s
Horms
-vb
Hormulario usado para crear
aplicaciones Windo+s-
Clase
-vb
Arc,ivo de Cdi(o )ue
contiene una declaracin de
clase-
Fecha: 12/01/2011
Mdulo
-vb
Arc,ivo para el
almacenamiento de (rupos
de &unciones-
DataSet
-6sd
En arc,ivo para crear un
es)uema FM2 con clases
DataSet-
Arc,ivo FM2 -6ml En arc,ivo FM2 en blanco
Es)uema FM2
-6sd
es)uema para documentos
FM2-
Control de Esuario
:eredado
-vb
En nuevo control basado en
&ormulario Web E6istente-
Arc,ivo FS2;
-6slt
En arc,ivo usado para
trans&ormar documentos
FM2-
Cristal Report
-rpt
En arc,ivo Cristal Report )ue
publica datos en un
&ormulario Web-
Arc,ivo de Mapa de $its
-bmp
En arc,ivo de mapa de bits
en blanco, )ue puede usarse
para crear im#(enes simples-
Arc,ivo de Cursor
-cur
En arc,ivo para crear
cursores personalizados-
Arc,ivo de 5cono
-ico
En arc,ivo de ima(en para
crear un icono personalizado-
Arc,ivo de recursos de
ensamblado -res6
En arc,ivo para editar '
de&inir recursos de
aplicaciones-
Arc,ivo de in&ormacin
sobre el ensamblado -vb
En arc,ivo )ue contiene
in&ormacin (eneral acerca
del ensamblado-
Arc,ivo de con&i(uracin
de la aplicacin -con&i(
En arc,ivo utilizado para
con&i(urar los valores de la
aplicacin-
Arc,ivo Script
-*s
En arc,ivo de comandos )ue
contiene cdi(o Script-
Arc,ivo VScript
-vbs
contiene cdi(o VScript-
3otaG 1ara el caso de 3omenclatura de los nombres de los &ormularios 4]-&rm8 se tiene
la si(uiente estructuraG
&rm^3omMod_Êntidad_Âccion_^Sec_
^3omMod_G 3ombre o Mdulo del Sistema 4AlmG Almacen, VtaG Ventas, ect8
Êntidad_G 3ombre de la entidad o proceso 4Hacturas, 1edidos, etc8
Âccion_G Accin a realizar sobre la entidad
Fecha: 12/01/2011
^Sec_G Secuencia )ue nos especi&ica el 9ltimo nivel de detalle dentro de la
estructura de &ormularios-
E*emplosG
&rmVtaHact5n(r 4ModuloG Venta, HactG Hactura, 5n(rG 5n(reso8
Fecha: 12/01/2011
@)/ E%e.e!$s "e -! P#$=ec$ &e'
E%e.e!$ P#$=ec$ EBe!s,+! A#ch,2$ P#$*+s,$ e%e.e!$ P#$=ec$
Web Horm
-asp6 ' -vb
En &ormulario usado para crear
aplicaciones Web
Servicio Web
-asm6 ' -vb
En componente )ue o&rece la
posibilidad de intercambiar
mensa*es interoperables
mediante el uso de protocolos
est#ndar, como ,ttp, FM2, FSD,
S>A1, ' WSD2-
Clase
-vb
Arc,ivo de cdi(o )ue contiene
una declaracin de clase-
Mdulo
-vb
Arc,ivo para el almacenamiento
de (rupos de &unciones-
DataSet
-6sd
es)uema FM2 con clases
DataSet-
Control de Esuario Web
-asc6
En control de Servidor AS1-3E;
creado mediante dise0ador
visual-
1a(ina :;M2
-,tm
Ena pa(ina :;M2 )ue puede
incluir cdi(os del lado del
cliente-
:o*a de Estilos
-css
Ena :o*a de estilos en cascada
utilizada para de&iniciones de
estilo :;M2 enri)uecido-
Arc,ivo FM2 -6ml En arc,ivo FM2 en blanco
Es)uema FM2
-6sd
es)uema para documentos FM2
Arc,ivo FS2;
-6slt
En arc,ivo usado para
trans&ormar documentos FM2
Clase de aplicacin
Global
-asa6
A veces conocida como arc,ivo
asa6, permite escribir cdi(o
para eventos (lobales AS1-3E;
de nivel de aplicacin tales
como SessionT>nStart '
ApplicationT>nStart- El arc,ivo
tiene como nombre (lobal-asa6
' no es posible cambiarlo-
Arc,ivo de Con&i(uracin
Web
-con&i(
AS1-3E; utiliza este arc,ivo
para con&i(urar los valores Web
de un pro'ecto Web- El arc,ivo
tiene como nombre +eb-con&i( '
no es posible cambiarlo-
Arc,ivo de Mapa de $its
-bmp
En arc,ivo de mapa de bits en
blanco, )ue puede usarse para
crear im#(enes simples-
Fecha: 12/01/2011
Arc,ivo de Cursor
-cur
En arc,ivo para crear cursores
personalizados-
Arc,ivo de 5cono
-ico
En arc,ivo de ima(en para crear
un icono personalizado-
Arc,ivo de recursos de
ensamblado
-res6
En arc,ivo para editar ' de&inir
recursos de aplicaciones-
Arc,ivo de in&ormacin
sobre el ensamblado -vb
En arc,ivo )ue contiene
in&ormacin (eneral acerca del
ensamblado-
Arc,ivo de con&i(uracin
de la aplicacin -con&i(
En arc,ivo utilizado para
con&i(urar los valores de la
aplicacin-
Arc,ivo Script
-*s
contiene cdi(o Script-
Arc,ivo VScript
-vbs
contiene cdi(o VScript-
Arc,ivo Script :ost
-+s&
En arc,ivo de cdi(o vaco )ue
se utiliza para crear secuencias
de comandos de Windo+s-
3otaG 1ara el caso de 3omenclatura de los nombres de los &ormularios Web 4]-asp68
se tiene la si(uiente estructuraG
^3omMod_Êntidad_Âccin_^Sec_
^3omMod_G 3ombre del Modulo o Sistema 4AlmG AlmacCn, VtaG Ventas, etc-8-
Êntidad_G 3ombre de la entidad o 1roceso 4Hacturas, 1edidos, etc-8-
Âccin_G Accin a realizar sobre la entidad-
^Sec_G Secuencia )ue especi&ica el 9ltimo nivel de detalle dentro de la estructura
de &ormularios
E*emplosG
&rmVtaHact5n(r4ModuloG Venta, HactG Hactura, 5n(rG 5n(reso8
&rmVtaHactConsul4ModuloG Venta, HactG Hactura, CnsulG Consulta8
Al(unas consideracionesG
Evitar reutilizar nombres para di&erentes elementos, tal como una rutina
llamada 1rocessSales ' una variable llamada i1rocessSales
Cuando asi(ne nombre a elementos, evite palabras di&ciles de deletrear
Fecha: 12/01/2011
@)@ Es#-c-#a "e -! P#$=ec$ &e'
Distribu'a l(icamente los arc,ivos / cdi(o &uente para &acilitar su ubicacin-
Ebicacin de los Arc,ivos para un 1ro'ecto WebG
Ca#*ea CML:
En esta carpeta estar#n todos los arc,ivos tipo -6ml
Ca#*ea I.a4es:
En esta carpeta van todos los arc,ivos (r#&icosG -*p(, -s+&, -(i&, -pn(
Ca#*ea S=%es:
En esta carpeta van los arc,ivos de EstilosG -css
Ca#*ea B,!:
En esta carpeta van los arc,ivos ensamblados 4Assemblies8G -dll
Ca#*ea Sc#,*:
Es esta carpeta van los arc,ivos tipo scriptG -*s, -vbs
Ca#*ea Te.*%aes:
En esta carpeta van los arc,ivos plantillaG -6slt
L$s F$#.-%a#,$s &e' 8)as*B9 se a(ruparan en una Sub Carpeta, identi&icada
con el nombre del 1roceso o de la Accin-
E*emploG
//Distribucin/&rmDistr5n(rHact-asp6
Fecha: 12/01/2011
@); C$!2e!c,$!es "e N$.'#e
@);)1 D,s,!c,+! "e .a=Dsc-%as = .,!Dsc-%as
1ara evitar con&usiones ' (arantizar la interoperacin entre len(ua*es, si(a estas
re(las con respecto a la distincin entre ma'9sculas ' min9sculasG
3o utilice nombres )ue re)uieran distincin entre ma'9sculas ' min9sculas-
2os componentes se deben poder utilizar en los len(ua*es )ue distin(uen, ' en
los )ue no distin(uen, entre ma'9sculas ' min9sculas- 2os len(ua*es )ue no
,acen esta distincin no pueden di&erenciar, dentro del mismo conte6to, dos
nombres )ue di&ieren slo en el uso de ma'9sculas ' min9sculas- 1or
consi(uiente, se debe evitar esta situacin en los componentes o clases
creados-
3o debe crear dos espacios de nombres con nombres )ue di&ieran slo en las
ma'9sculas ' min9sculas- 1or e*emplo, un len(ua*e )ue no ,a(a distincin
entre ma'9sculas ' min9sculas no distin(ue entre las dos declaraciones
si(uientes de espacio de nombres-
namespace ee-cummin(s[
namespace Ee-Cummin(s
3o debe crear una &uncin con nombres de par#metros )ue di&ieran slo en las
ma'9sculas ' min9sculas- El si(uiente e*emplo es incorrecto-
void M'Hunction4strin( a, strin( A8
3o cree un espacio de nombres con nombres de tipos )ue di&ieran slo en las
ma'9sculas ' min9sculas- En el si(uiente e*emplo, 1oint p ' 1>53; p son
nombres de tipo incorrectos 'a )ue di&ieren slo en el uso de las ma'9sculas '
min9sculas-
S'stem-Windo+s-Horms-1oint p
S'stem-Windo+s-Horms-1>53; p
3o debe crear un tipo con nombres de propiedades )ue di&ieran slo en las
ma'9sculas ' min9sculas- En el si(uiente e*emplo, int Color ' int C>2>R son
nombres de propiedades incorrectos 'a )ue di&ieren slo en el uso de las
ma'9sculas ' min9sculas-
int Color `(et, seta
int C>2>R `(et, seta
3o debe crear un tipo con nombres de mCtodos )ue di&ieran slo en las
ma'9sculas ' min9sculas- En el si(uiente e*emplo, calculate ' Calculate son
nombres de mCtodos incorrectos 'a )ue di&ieren slo en el uso de las
ma'9sculas ' min9sculas-
void calculate48
Fecha: 12/01/2011
void Calculate48
Cuando escriba :;M2, establecer un &ormato est#ndar para ta(s ' atributos,
tal como todo ma'9sculas para ta(s ' min9sculas para atributos
@);)2 Ma=Dsc-%as = .,!Dsc-%as *asca%
2a primera letra del identi&icador ' la primera letra de las si(uientes palabras
concatenadas est#n en ma'9sculas ' min9sculas 1ascal se puede utilizar en
identi&icadores de tres o m#s caracteres- 1or E*emplo $acIColor-
@);)/ Ma=Dsc-%as = .,!Dsc-%as ca.e%
2a primera letra del identi&icador est# en min9scula ' la primera letra de las si(uientes
palabras concatenadas con ma'9scula-
I"e!,1,ca"$#
Es,%$ Ma=Dsc-%as /
M,!Dsc-%as
E?e.*%$
Clase 1ascal AppDomain
;ipo Enum 1ascal Error2evel
Valor Enum 1ascal HatalError
Clase de
e6cepciones
1ascal
WebE6ception
3otaG ;ermina siempre con el su&i*o
E6ception
Campo estatico
solo lectura
1ascal
RedValue
5nter&az
1ascal
5Disposable
3otaG Comienza siempre con el
pre&i*o 5
MCtodo 1ascal ;oStrin(
Espacio de
3ombres
1ascal
S'stem-Dra+in(
1ar#metro Camel t'pe3ame
1ropiedad 1ascal $acIColor
Campo instancia
prote(ido
Camel
redValue
3otaG Se utiliza en contadas
ocasiones- Es pre&erible usar
una propiedad en vez de un
campo de instancia prote(ido
Campo instancia
publico
1ascal
RedValue
3otaG Se utiliza en contadas
ocasiones- Es pre&erible utilizar
una propiedad, en vez de un
campo de instancia p9blico-
Fecha: 12/01/2011
@);)@ A'#e2,a-#as
1ara evitar con&usiones ' (arantizar la interoperacin entre len(ua*es, si(a estas
re(las con respecto a la utilizacin de abreviaturasG
3o utilice abreviaturas ni contracciones como parte de nombres de
identi&icadores- 1or e*emplo, utilice GetWindo+ en vez de GetWin-
3o utilice acrnimos )ue no estCn aceptados en el campo de la in&orm#tica-
Si es necesario, utilice acrnimos conocidos para reemplazar nombres en
&rases lar(as- 1or e*emplo, utilice E5 para inter&az de usuario ' >2A1 para
procesamiento analtico en lnea-
Cuando utilice acrnimos, utilice el estilo de ma'9sculas ' min9sculas en
acrnimos de m#s de dos caracteres- 1or e*emplo, use :tml$utton o
,tml$utton- Sin embar(o, deber# utilizar ma'9sculas en acrnimos )ue ten(an
slo dos caracteres, por e*emplo S'stem-5> en vez de S'stem-5o-
3o utilice abreviaturas en nombres de identi&icadores o par#metros- Si tiene
)ue utilizar abreviaturas, utilice las Ma'9sculas ' min9sculas en abreviaturas
de dos o m#s caracteres, aun)ue esto contradi(a la abreviatura est#ndar de la
palabra-
Minimize el uso de abreviaciones- Ena abreviacin debera tener solo un
si(ni&icado- Cada palabra abreviada debera tener una sola abreviacin- 1or
e*emplo si Ed usa min para abreviar minimum ' no volver a usar min para
abreviar tambiCn minuto
@);); E%ecc,$!es "e *a%a'#a
Evite usar nombres de clases )ue dupli)uen los espacios de nombres utilizados
,abitualmente en -3E; &rame+orI- 1or E*emplo no utilice nin(uno de los nombres
si(uientes como nombres de clasesG S'stem-Collections, Horms o E5-
MEZ 5M1>R;A3;EG Evite utilizar identi&icadores )ue entren en con&licto con las
si(uientes palabrasG
Add,andler Address>& Alias And A3S5
As Assembl' Auto $ase $olean
$'Re& $'te $'Val Call Case
Catc, C$ool C$'te CC,ar CDate
CDec CDbl C,ar C5nt Class
C2n( C>b* Const CS,ort CSn(
CStr C;'pe Date Decimal Declare
De&ault Dele(ate Dim Do Double
Eac, Else Else5& End Enum
Erase Error Event E6it E6ternalSource
Halse Hinalize Hinall' Hloat Hor
Fecha: 12/01/2011
Hriend Hunction Get Get;'pe Go;o
:andles 5& 5mplements 5mports 5n
5n,erits 5nte(er 5nter&ace 5s 2et
2ib 2iIe 2on( 2oop Me
Mod Module Must5n,erits Must>verride M'$ase
M'Class 3amespace 3e+ 3e6t 3ot
3ot,in( 3ot5n,eritable 3ot>verridable >b*ect >n
>pcion >ptional >r >verloads >verridable
>verrides 1aramArra' 1reserve 1rivate 1ropert'
1rotected 1ublic RaiseEvent Read>nl' ReDim
Re(ion REM Remove:andler Resume Return
Select Set S,ado+s S,ared S,ort
Sin(le Static Step Stop Strin(
Structure Sub S'nc2ocI ;,en ;,ro+
;o ;rae ;r' ;'pe>& Enicote
Entil Volatile W,en W,ile Wit,
Wit,Events Write>nl' For Eval E6tends
instance>& 1acIa(e Var
@);)E E2,a# c$!1-s,+! "e !$.'#es "e ,*$s
2os distintos len(ua*es de pro(ramacin utilizan tCrminos di&erentes para identi&icar los
tipos administrados b#sicos- 2os dise0adores de bibliotecas de clases deben evitar
utilizar terminolo(a espec&ica del len(ua*e- Si(a las re(las )ue se describen en esta
seccin para evitar la con&usin de nombres de tipos-
Etilice nombres )ue describan el si(ni&icado del tipo, en vez de nombres )ue describan
el tipo- En el caso poco &recuente de )ue un par#metro no ten(a nin(9n otro
si(ni&icado sem#ntico aparte del si(ni&icado del tipo, utilice un nombre (enCrico- 1or
e*emplo, una clase )ue admite la escritura de diversidad de tipos de datos en una
secuencia puede tener los mCtodos si(uientes-
Sub Write4value As Double8[
Sub Write4value As Sin(le8[
Sub Write4value As 2on(8[
Sub Write4value As 5nte(er8[
Sub Write4value As S,ort8[
3o cree nombres de mCtodos con terminolo(a espec&ica del len(ua*e, como se
muestra en el si(uiente e*emplo-
Sub Write4doubleValue As Double8[
Sub Write4sin(leValue As Sin(le8[
Sub Write4lon(Value As 2on(8[
Sub Write4inte(erValue As 5nte(er8[
Sub Write4s,ortValue As S,ort8[
Fecha: 12/01/2011
En el caso e6cepcional de )ue sea necesario crear un mCtodo con un nombre 9nico
para cada tipo b#sico de datos, utilice nombres de tipos universales- En la tabla
si(uiente se muestran los nombres de tipos b#sicos ' las sustituciones universales-
N$.'#e
"e ,*$ CF
N$.'#e "e
,*$ 0,s-a%
Bas,c
N$.'#e "e
,*$ GSc#,*
N$.'#e "e
,*$ 0,s-a% C:
:
Re*#ese!ac,+
! I%as.)eBe
N$.'#e "e
,*$
-!,2e#sa%
sb'te S$'te s$'te c,ar int\ S$'te
b'te $'te b'te unsi(ned c,ar unsi(ned int\ $'te
s,ort S,ort s,ort s,ort int"7 5nt"7
us,ort E5nt"7 us,ort unsi(ned s,ort unsi(ned int"7 E5nt"7
int 5nte(er int int int=. 5nt=.
uint E5nt=. uint unsi(ned int unsi(ned int=. E5nt=.
lon( 2on( lon( TTint7< int7< 5nt7<
ulon( E5nt7< ulon( unsi(ned
TTint7<
unsi(ned int7< E5nt7<
&loat Sin(le &loat &loat &loat=. Sin(le
double Double double double &loat7< Double
bool $oolean boolean bool bool $oolean
c,ar C,ar c,ar +c,arTt c,ar C,ar
strin( Strin( strin( Strin( strin( Strin(
ob*ect >b*ect ob*ect >b*ect ob*ect >b*ect
1or e*emplo, una clase )ue admita la lectura de diversidad de tipos de datos en una
secuencia puede tener los si(uientes mCtodos-
ReadDouble48As Double
ReadSin(le48As Sin(le
Read5nt7<48As 2on(
Read5nt=.48As 5nte(er
Read5nt"748As S,ort
Es pre&erible utilizar el e*emplo anterior, en vez de la alternativa espec&ica de len(ua*e
)ue se muestra a continuacin-
ReadDouble48As Double
ReadSin(le48As Sin(le
Read2on(48As 2on(
Read5nte(er48As 5nte(er
ReadS,ort48As S,ort
Fecha: 12/01/2011
@);)H I!s#-cc,$!es 4e!e#a%es "e !$.e!c%a-#a "e es*ac,$ "e !$.'#es
8!a.es*ace9
1or re(la (eneral, en los espacios de nombres se utiliza el nombre de la compa0a
se(uido del nombre de la tecnolo(a ', opcionalmente, la caracteristica ' el dise0o
como se muestra a continuacin
Compan'3ame-;ec,nolo('3ame^-Heature_ ^-Desi(n_
1or E*emplo
Microso&t-Media
Microso&t-Media-Desi(n
Al incluir un pre&i*o en los nombres de los espacios de nombres )ue conten(an el
nombre de una compa0a o marca de reconocido presti(io, se evita la posibilidad de
publicar dos espacios de nombres )ue ten(an el mismo nombre- 1or E*emplo,
Microso&t->&&ice es un pre&i*o adecuado para las clases de automatizacin de >&&ice
)ue proporciona Microso&t-
Etilice un nombre de tecnolo(a reconocida ' estable en el se(undo nivel de un
nombre *er#r)uico- Etilice la *erar)ua or(anizativa cono base para la *erar)ua de
espacios de nombres- Asi(ne un nombre a un espacio de nombres )ue conten(a los
tipos )ue proporcionan &uncionalidades en tiempo de dise0o para un espacio de
nombres base con el su&i*o -Desi(n 1or e*emplo, el Espacio de nombres
S'stem-Windo+s-Horms-Desi(n contiene las clases de dise0ador ' clases
relacionadas para dise0ar aplicaciones basadas en S'stem-Windo+s-Horms-
En espacio de nombres anidado debe tener una dependencia en los tipos del espacio
de nombres contenedor- 1or e*emplo, las clases de S'stem-Web-E5-Desi(n dependen
de las clases de S'stem-Web-E5- 3o obstante, las clases de S=se.)&e')UI no
dependen de las clases en S=se.)&e')UI)Des,4!-
En los espacios de nombres, se debe utilizar el estilo de Ma'9sculas ' min9sculas '
separar los componentes l(icos con puntos, como en Microso&t->&&ice-1o+er1oint- Si
la marca utilizada no emplea la re(la de ma'9sculas ' min9sculas tradicional, si(a el
sistema )ue utiliza la marca, aun)ue no si(a la re(la- 1or e*emplo, los espacios de
nombres 3eF;-Web>b*ects ' ee-cummin(s muestran las variaciones correctas de
utilizacin de ma'9sculas ' min9sculas con respecto a la re(la-
Etilice los nombres de espacios de nombres en plural, siempre )ue sea correcto
sem#nticamente- 1or e*emplo, utilice S'stem-Collections en vez de S'stem-Collection-
2as e6cepciones a esta re(la son los nombres ' abreviaturas de marcas- 1or e*emplo,
utilice S'stem-5> en vez de S'stem-5>s-
3o utilice el mismo nombre para un espacio de nombres ' para una clase- 1or
e*emplo, no proporcione un espacio de nombres Debu( ' una clase Debu(- 1or 9ltimo,
ten(a en cuenta )ue el nombre de un espacio de nombres no tiene )ue ser an#lo(o al
nombre del ensamblado- 1or e*emplo, si asi(na el nombre
M'Compan'-M';ec,nolo('-dll a un ensamblado, no es necesario )ue conten(a un
espacio de nombres M'Compan'-M';ec,nolo('-
Fecha: 12/01/2011
@);)I I!s#-cc,$!es "e !$.e!c%a-#a "e .$"-%$s = c%ases
En las re(las si(uientes se describen las instrucciones de nomenclatura de clasesG
Etilice el estilo de Ma'9sculas ' min9sculas Camel-
3o Etilice el car#cter de subra'ado 4T8
Etilice las abreviaturas con moderacin-
Etilice un pre&i*o de = caracteresG Mod para Mdulos para las clases de&ina un
nombre representativo de la &uncionalidad de esta-
2ue(o del pre&i*o, utilice un sustantivo o una sinta6is nominal para asi(nar un
nombre al mdulo-
3o utilice un pre&i*o de tipo, como C para clase, en un nombre de clase- Etilice,
por e*emplo, el nombre de clase Graba1ropiedades en vez de
CGraba1ropiedades-
De vez en cuando, es necesario proporcionar un nombre de clase )ue
comience con la letra 5, aun)ue la clase no sea una inter&az- Esto es correcto
siempre )ue 5 sea la primera letra de una palabra )ue &orme parte del nombre
de la clase- 1or e*emplo, 5dentit'Store es un nombre de clase correcto-
Cuando sea apropiado, utilice una palabra compuesta en el nombre de una
clase derivada- 2a se(unda parte del nombre de la clase derivada debe ser el
nombre clase base- 1or e*emplo, ApplicationE6ception es un nombre correcto
para una clase derivada de la clase E6ception, pues ApplicationE6ception es
una clase de E6ception- En esta re(la se debe utilizar la l(ica- 1or e*emplo,
$utton es un nombre adecuado para una clase derivada de Control- Aun)ue un
botn es una clase de control, si inclu'e Control como parte del nombre de una
clase alar(ara el nombre innecesariamente-
A continuacin, se inclu'en al(unos e*emplos de clases con nombres
correctosG
1ublic Class F,%eS#ea.
1ublic Class B-$!
1ublic Class S#,!4
@);)J I!s#-cc,$!es "e !$.e!c%a-#a "e ,!e#1ases
Asi(ne nombres a inter&aces utilizando sustantivos, sinta(mas nominales o
ad*etivos )ue describan su comportamiento- 1or e*emplo, en el nombre de la
inter&az IC$.*$!e! se utiliza un sustantivo descriptivo- En el nombre de la
inter&az IC-s$.A#,'-eP#$2,"e# se utiliza un sinta(ma nominal- En el nombre
IPe#s,sa'%e se utiliza un ad*etivo-
Etilice el estilo de Ma'9sculas ' min9sculas 55nter&ase
5nclu'a un pre&i*o con la letra 5 en los nombres de inter&aces para indicar )ue el tipo
es una inter&az-
Fecha: 12/01/2011
Etilice nombres similares cuando de&ina un par clase/inter&az, donde la clase es
una implementacin est#ndar de la inter&az- 2os nombres deben ser distintos slo
en el pre&i*o 5 del nombre de la inter&az-
3o utilice el car#cter de subra'ado 4T8, es decir, T5component-
A continuacin, se inclu'en al(unos e*emplos de inter&aces con nombres correctosG
1ublic 5nter&ace 5Service1rovider
1ublic 5nter&ace 5Hormatable
En el si(uiente e*emplo de cdi(o se muestra cmo de&inir la inter&az IC$.*$!e!
' su implementacin est#ndar, la clase C$.*$!e!-
1ublic 5nter&ace 5Component
O 5mplementation code (oes ,ere-
End 5nter&ace
1ublic Class Component
5mplements 5Component
O 5mplementation code (oes ,ere-
End Class
@);)10 N$.e!c%a-#a "e c$!#$%es = 1$#.-%a#,$s
O'?e$ P#e1,?$ E?e.*%$
Horm &rm &rmDataEntr'
$utton 4WinHorms8 /
Command$utton 4WebHorms8
btn btnE6it
;e6t$o6 t6t t6t1a'mentAmount
2abel lbl lbl;otal
Radio $utton rad rad$old
C,ecI$o6 c,I c,I1rintSummar'
:orizontalScroll$ar ,sb ,sbRate
VerticalScroll$ar vsb vsb;emperature
1icture$o6 pic pic2andscape
Combo$o6 4WinHorms8 /
DropDo+n2ist 4WebHorms8
cbo cbo$ooI2ist
2ist$o6 lst lst5n(redients
2inI2abel llb
Menu mnu
Group$o6 (rp
1anel pnl
DataGrid d(r
C,ecIed2ist$o6 clb
2istVie+ lv+
;reeVie+ tv+
Date;ime1icIer dtp
Mont,Calendar cal
Fecha: 12/01/2011
;imer clI
Splitter Spl
DomainEpDo+n Dud
3umericEpDo+n 3ud
;racI$ar ;rb
Ric,;e6t$o6 Rtb
5ma(e2ist 5ml
:elp1rovider :pp
;ool;ip ;ip
Conte6tMenu Cmn
;ool$ar ;br
Status$ar Stb
3oti&'5con 3ic
>penHileDialo( >&d
SaveHileDialo( >&d
HontDialo( Hnt
ColorDialo( Crd
Error1rovider erp
;abControl ;ab
@);)11 N$.e!c%a-#a "e a#,'-$s
Deber# a(re(ar siempre el su&i*o Attribute a las clases de atributos personalizados- A
continuacin, se inclu'e un e*emplo de un nombre correcto de clase de atributoG
1ublic Class >bsoleteAttribute
@);)12 N$.e!c%a-#a "e 2a#,a'%es
En lo posible no usar variables Globales, solo se deben utilizar en los casos )ue
sea estrictamente necesario- Si utiliza variables (lobales en un &ormulario o clase,
estos deben ser declarados como privados-
3o usar D5M para declarar variables a nivel de clase, use solo 1rivate o 1ublic- 3o
usar 1ublic con &recuencia-
Esar siempre >ption E6plicit ;rue- Esto re)uerir# )ue todas las variables sean
declaradas- 4>pcin con&i(urada a nivel de 1ro'ecto8
Esa siempre >ption Strict ;rue- Esto re)uerir# conversiones de tipo e6plicitas-
4>pcin con&i(urada a nivel de 1ro'ecto8
Evitar usar tCrminos tales como Hla( para variables de estado- Estas variables a
di&erencia de las variables $oolean, pueden tener mas de dos posibles valores-
Fecha: 12/01/2011
En vez de document&la(, use un nombre m#s descriptivo tal como
documentHormat;'pe
Evitar reutilizar nombres para di&erentes elementos, tal como una rutina llamada
1rocessSales ' una variable llamada i1rocessSales
Cuando asi(ne nombre a elementos, evite palabras di&ciles de deletrear-
Etilice un pre&i*o de una letra para indicar el alcance o #mbito de la variable, se(9n
la si(uiente tablaG
T,*$ P#e1,?$
A nivel de mdulo o clase m
A nivel de modulo o clase para variables
)ue sirven de repositorio a las propiedades
de la Clase
D
2ocales l
1ar#metros p
A nivel General o sistema (
E?e.*%$s:
mstrCadenaConexion Variable de Mdulo o Clase
_dsOrigenDatos Variable contenedora de la Propiedad DataSource
lstrArchivo Parmetro se considera al tipo de dato !unto con
la letra "p# todo el su$i!o de la variable% por ende
va en min&sculas'
gstrCodCia Variable (ocal del Cdigo de Compa)*a
A(re(ue otro pre&i*o de una a tres letras para indicar el tipo de datos de la variable,
se(9n la si(uiente tablaG
T,*$ 0,s-a%
Bas,c
T,*$ CLR P#e1,?$ A%.ace!a.,e!$ N$.,!a%
$olean S'stem-$oolean bln . b'tes
$'te S'stem-$'te bt " b'te
C,ar S'stem-C,ar c . b'tes
Date S'stem-Date;ime dt \ b'tes
Decimal S'stem-Decimal dec "7 b'tes
Double S'stem-Double dbl \ b'tes
5nte(er S'stem-5nt=. int < b'tes
2on( S'stem-5nt7< ln( \ b'tes
>b*ect S'stem->b*ect ob* < b'tes
S,ort S'stem-5nt"7 s, . b'tes
Sin(le S'stem-Sin(le sn( < b'tes
Strin( S'stem-Strin( str En &uncin de la plata&orma
de implementacin
Fecha: 12/01/2011
E?e.*%$s:
TstrCodClt Variable a nivel de Mdulo o Clase, tipo cadena, Cdi(o del
Cliente-
mstr3ombreEmp Variable a nivel de Mdulo, tipo Cadena, 3ombre del empleado-
ldecSueldo Variable local, tipo Decimal, Sueldo-
lblnCasado Variable local, tipo $oolean, Casado-
En caso de Clases de&inidas por el usuario, se utiliza el pre&i*o ob* como se indica en la
tabla anterior- 1or e*emploG
mob*Cliente Variable a nivel de Mdulo, ob*eto de la clase Cliente-
lob*Hactor Variable local, ob*eto de la clase Hactor-
O'se#2ac,+!: Se considerara como una de&inicin de variables v#lidas a Ji,*,I,bK
siempre ' cuando estas representen a los ndices dentro de una iteracin 8%$$*9
dentro de una coleccin o arre(lo-
Dim i as 5nte(er Dim i, * as 5nte(er
Dim * as 5nte(er
3o use n9meros literales strin( literal, tal como Hor i R " ;o c- En lu(ar use
constantes tal como Hor i R " ;o dT3EMTDAZST53TWEEd, para &acilitar el
mantenimiento ' comprensin-
En el caso de variables ob*eto de acceso a datos 4AD>-3E;8, se utilizaran los
si(uientes pre&i*osG
T,*$ P#e1,?$
Connection cnn
Command cmd
DataAdapter Da
DataReader Dr
DataSet Ds
Data;able Dt
DataRo+ Dro+
DataColumn Dcol
DataRelation Drel
E?e.*%$:
CnnCone6ionD$ Variable de tipo S)lConnection u >ledbConnection,
Cone6ionD$
Cmd1rocesarDetalle Variable de tipo S)lCommand u >ledbCommand,
1rocesaDetalle-
Fecha: 12/01/2011
@);)1/ N$.e!c%a-#a "e c$!sa!es
Etilice como pre&i*o de las constantes la letra JdK en ma'9scula se(uido del
car#cter JEnderlineK 4 T 8
3ombre las constantes como nombres o abreviaciones de nombres-
Etilice solo Ma'9sculas-
Colo)ue tipo a las constantes- 1or E*emploG
Const dT5GV As Decimal R !-"\
@);)1@ N$.e!c%a-#a "e e!-.e#ac,$!es
El ;ipo de valor de enumeracin 4Enum8 se ,ereda de la Clase Enum- En las re(las
si(uientes se describen las instrucciones de nomenclatura de enumeracionesG
Etilice el estilo de Ma'9sculas ' min9sculas 1ascal en los nombres de valores
' tipos Enum-
3o utilice el su&i*o Enum en nombres de tipo Enum-
Etilice un nombre en sin(ular para la ma'ora de los tipos Enum, pero utilice un
nombre en plural para los tipos Enum )ue son campos de bits-
@);)1; N$.e!c%a-#a "e ca.*$s esa,c$s
Etilice sustantivos, sinta(mas nominales o abreviaturas de nombres al asi(nar
nombres a campos est#ticos-
Etilice el estilo de Ma'9sculas ' min9sculas E*emploG Re"0a%-e
Se recomienda utilizar propiedades est#ticas en lu(ar de campos est#ticos
p9blicos cada vez )ue sea posible-
@);)1E N$.e!c%a-#a "e *a#a.e#$s
Es importante se(uir estas instrucciones de nomenclatura de par#metros, 'a )ue las
,erramientas de dise0o visual )ue proporcionan a'uda conte6tual ' &uncionalidad de
e6ploracin de clases muestran en el dise0ador los nombres de los par#metros de
mCtodos a los usuarios- En las re(las si(uientes se describen las instrucciones de
nomenclatura de par#metrosG
Etilice el estilo de Ma=Dsc-%as = .,!Dsc-%as para los nombres de par#metros-
E*emploG =*eNa.e
Fecha: 12/01/2011
Etilice nombres de par#metros descriptivos- 2os nombres de par#metros deben
ser lo su&icientemente descriptivos como para )ue el nombre ' el tipo del
par#metro se puedan utilizar para determinar su si(ni&icado en la ma'ora de
los escenarios- 1or e*emplo, las ,erramientas de dise0o visual )ue
proporcionan a'uda conte6tual muestran los par#metros de los mCtodos a los
pro(ramadores mientras escriben- 1or tanto, los nombres de los par#metros
deberan ser lo su&icientemente descriptivos en este escenario como para
permitir a los pro(ramadores suministrar los par#metros adecuados-
Etilice nombres )ue describan el si(ni&icado del par#metro, en vez de nombres
)ue describan el tipo de par#metro- 2as ,erramientas de desarrollo deben
proporcionar in&ormacin descriptiva sobre el tipo de par#metro- 1or tanto, el
nombre del par#metro tambiCn sirve para describir su si(ni&icado- Etilice los
nombres de par#metros basados en tipos con moderacin ' slo cuando sea
correcto-
3o utilice par#metros reservados- 2os par#metros reservados son par#metros
privados )ue se pueden e6poner en &uturas versiones, si as se precisa- En vez
de esto, si se necesitan m#s datos en una versin &utura de la biblioteca de
clases, a(re(ue una nueva sobrecar(a para un mCtodo-
A continuacin, se inclu'en al(unos e*emplos de par#metros con nombres
correctosG
Get;'pe4=*eNa.e As Strin(8As ;'pe
Hormat41$#.a As Strin(, a#4s48 As ob*ect8As Strin(
@);)1H N$.e!c%a-#a "e .e$"$sK *#$ce",.,e!$s = 1-!c,$!es
En las re(las si(uientes se describen las instrucciones de nomenclatura de mCtodosG
Etilice verbos o sinta6is variables al asi(nar nombres de los mCtodos-
Etilice el estilo de Ma'9sculas ' min9sculas 1ascal-
Etilice cali&icados e6plcitos % 1ublic, 1rivate, etc-
En len(ua*es orientados a ob*etos, es redundante incluir el nombre de clase en
el nombre de propiedades de clase, tal comoG $ooI-$ooI;itle- en lu(ar de usar
$ooI-;itle-
Ese procedimientos 4Sub8 en lu(ar de &unciones si el mCtodo no tiene valor de
retorno-
3o utilice la palabra Call para la llamada
Etilice nombres de par#metros descriptivos- 2os nombres de par#metros deben
ser lo su&icientemente descriptivos como para el nombre ' el tipo del
par#metro- 1or tanto, el nombre de par#metro tambiCn sirve para describir su
si(ni&icado- Etilice los nombres de par#metros basados en tipos con
moderacin ' solo cuando sea correcto-
3o utilice par#metros reservados- 2os par#metros reservados son par#metros
privados )ue se pueden e6poner en &uturas versiones, si as se precisa- En vez
Fecha: 12/01/2011
de esto, si se necesitan m#s datos en una versin &utura de la biblioteca de
clases, a(re(ue una nueva sobrecar(a para un mCtodo-
Etilice el pre&i*o JpK para indicar un par#metro de mCtodo-
De*e el tipo de par#metro como $'Val- Solo use $'Re& cuando sea
estrictamente necesario-
3o usar pre&i*o &n para &unciones de&inidas por el usuario, Dic,o pre&i*o esta
reservado para identi&icar &unciones propias del sistema-
Cuando asi(ne nombres a &unciones, incluir una descripcin del valor
retornado, tal como G GetCurrentWindo+3ame
@);)1I N$.e!c%a-#a "e *#$*,e"a"es
En las re(las si(uientes se describen las instrucciones de nomenclatura de
propiedadesG
Etilice un sustantivo o una sinta6is nominal al asi(nar nombres a las
propiedades-
Etilice el estilo de ma'9sculas ' min9sculas 1ascal- E*emplo BacLC$%$#
Es conveniente crear una propiedad con el mismo nombre )ue el tipo
sub'acente correspondiente- 1or E*emplo, si declara una propiedad con el
nombre Color, el tipo de propiedad tambiCn deber# llamarse Color-
En el si(uiente e*emplo de cdi(o se muestra cmo asi(nar nombres correctos
a propiedades-
1ublic Class SampleClass
1ublic 1ropert' BacLC$%$# As Color
O Code &or Get and Set accessors (oes ,ere-
End 1ropert'
End Class
En el si(uiente e*emplo de cdi(o se muestra cmo proporcionar una
propiedad con el mismo nombre )ue el tipo-
1ublic Enum Color
O 5nsert code &or Enum ,ere-
End Enum
1ublic Class Control
1ublic 1ropert' Color As C$%$#
Get
O 5nsert code ,ere-
End Get
Set
O 5nsert code ,ere-
End Set
Fecha: 12/01/2011
End 1ropert'
End Class
El si(uiente e*emplo de cdi(o es incorrecto 'a )ue la propiedad Color es de
tipo 5nte(er-
1ublic Enum Color
O 5nsert code &or Enum ,ere-
End Enum
1ublic Class Control
1ublic 1ropert' Color As I!e4e#
Get
O 5nsert code ,ere-
End Get
Set
O 5nsert code ,ere-
End Set
End 1ropert'
End Class
En el e*emplo incorrecto, no es posible ,acer re&erencia a los miembros de la
enumeracin Color- Color-F66 se interpretar# como )ue tiene acceso a un
miembro )ue primero obtiene el valor de la propiedad C$%$# 4tipo I!e4e# en
Visual $asic o tipo ,! en C@8 ' )ue, a continuacin, tiene acceso a un miembro
de ese valor 4)ue tendr# )ue ser un miembro de instancia de S=se.)I!/28-
@);)1J N$.e!c%a-#a "e R-,!as
Evite usar nombres alusivos )ue sean abiertos a interpretacin sub*etiva, tal
comoG
Anal'ze;,is48 - ;ales nombres contribu'en a una ambi(eedad
m#s )ue abstraccin-
Esar el mCtodo Verbo % 3ombre, para asi(nar nombres de rutinas )ue e*ecutan
al(una operacin 9 ob*eto dado- E*emplo G Calculate5nvoice;otal48-
1ara a'udar a distin(uir entre variables ' rutinas[ use 1ascal
4Calculate5nvoice;otal8 para nombre de rutinas donde la primera letra de cada
palabra es ma'9scula- 1ara nombre de variable, use Camel
4documentHormat;'pe8 donde la primera letra de cada palabra e6cepto la
primera es ma'9scula-
@);)20 Ma!e?$ "e EBce*c,$!es
Fecha: 12/01/2011
Se debe mane*ar errores para toda accin comando a e*ecutar, as tambien se debe
matar los ob*etos creados cuando de*en de ser utilizados- Se recomienda no usar los
errores en bucles e6tensos-
fMane*ador de error
tr'
Comando a e*ecutar
Catc,
Recepcin del error
Hinall' f 1ara matar los ob*etos creados en el procedimiento &uncion
>b*eto-dispose
>b*eto R not,in(
End tr'
Etilice mane*o de errores estructurado
3o utilice >n Error Goto
Corri*a problemas si es posible-
Considere la in&ormacin adicional 9til a la e6cepcin-
Considere proporcionar in&ormacin 9til a la e6cepcin-
;) DOCUMENTACIN
;)1 Desc#,*c,+! "e C%ase / M$"-%$
Cada Clase debe ser precedida por una descripcin de clase del si(uiente &ormato
fffCreado porG
fffModi&icado porG
fffDescripcinG2a descripcin de esta clase contendr# el propsito de la clase-
Fecha: 12/01/2011
fff2ista de par#metros4si los re)uiere8
;)2 Desc#,*c,+! "e P#$ce",.,e!$
Cada procedimiento 4Sub, Hunction, o 1ropert'8 debe incluir la si(uiente
descripcin- Si los campos est#n en blanco, las eti)uetas pueden ser eliminadas
41or e*emplo, un Sub no necesita cdi(o de retorno8-
2os par#metros se listan en orden ' eti)uetados con în_, în, out_, o ôut_ se(9n sea
apropiado- 2os datos devueltos en los par#metros de salida se deben mostrar
a)u-
1ublic >verloads Sub Validar4$'Val pstr5nput as Strin(8
fffCreado porG
fffModi&icado porG
fff1ar#metrosG
fff în_ pstr5nput G Describir el propsito de 5nput
;)/ C$.e!a#,$s "e!#$ "e %a F-!c,+!
2os Comentarios dentro de la Huncin deben ser de tres tiposG
Comentarios en las declaraciones de las variables son apropiados en la misma
lnea de la declaracin con una indentacin consistente-
Comentarios )ue describen un (ran blo)ue de cdi(o deberan tener una lnea
en blanco, lue(o del comentario con un car#cter de comentario ' un espacio
precedente por cada lnea, 3o debe ,aber nin(9n espacio interviniente entre
este comentario ' el cdi(o )ue continua-
2neas individuales o (rupos de lneas pueden ser comentados con una lnea
con solo un car#cter de comentario, lue(o el comentario sin espacio
precedente por cada lnea, lue(o una lnea &inal con un solo car#cter de
comentario-
El resultado es un procedimiento totalmente comentado donde el &ormato de
comentario no distrae del &lu*o del cdi(o, ' la asociacin entre el cdi(o ' su
comentario es visualmente claro-
1ublic >verloads Hunction Validar T
4$'Val pstr1aram" As Strin(, T
$'Re& pstr1aram. As Strin(8 As Strin(
fffCreado porG
fffModi&icado porG
fff1ar#metrosG
fff în_ pstr5nput G Describir el propsito de 5nput
fff DevuelveG
fff Descripcin de lo )ue la Huncin devuelve-
fffEste $lo)ue de comentarios describe las variables locales
Fecha: 12/01/2011
Dim localVar" as Strin( fAlmancena el contenido de t6t5nput
Dim localVar. as 5nte(er fAlmacena el len(t, de t6t5nput
f Este $lo)ue de comentarios es usado para describir las si(uientes lneas de cdi(o
localVar" R t6t5nput-;e6t
5& localVar"-2en(t, R ! ;,en
localVar" R J3o ,a' ;e6to-K
End 5&
End Sub

Anexo 1 - Estandares de Desarrollo Web V1

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Anexo 1 - Estandares de Desarrollo Web V1

Caricato da

Copyright:

Formati disponibili

CLUB RECREACIONAL TUNQUI

Estandares de Desarrollo Web

Potrebbero piacerti anche