Вы находитесь на странице: 1из 2

1 Introduccin

1.1 Propsito del documento


<Insertar los propsitos particulares del documento para la institucin>
El cdigo debe ser desarrollado siguiendo estndares de desarrollo para facilitar su lectura y la
modificacin por cualquier miembro del equipo de desarrollo.
Para poder llevar a cabo con xito la propiedad colectiva del cdigo esta prctica es decisiva. La
propiedad colectiva sera impensable sin una codificacin basada en estndares que haga que
todo el mundo se sienta cmodo con el cdigo escrito por cualquier otro miembro del equipo.
i se requiere profundi!ar en la herramienta" o bien ver e#emplos de estndares de codificacin
existentes se sugiere leer el documento$ %ua&Estandares&'odificacion.doc
2 Estndares de codificacin
El propsito fundamental de los estndares de codificacin es que [[Nombre del Proyecto]] tenga
una arquitectura y un estilo consistente" independiente del autor" con lo cul el sistema resulte fcil
de entender y por supuesto fcil de mantener. El mayor problema que trata de enfrentar esta
prctica" como fue mencionado al principio" es el tratar de entender el formato y el estilo utili!ado
en el cdigo escrito por otros desarrolladores.
Los estndares de codificacin son un complemento a la programacin por pares y no slo es
importante tener un estndar" sino tener un buen estndar de codificacin" de esta forma un buen
estndar de codificacin deber$
'larificar ms que confundir.
Promover la intencin del cdigo.
Permitir que los programas se acerquen lo me#or posible al lengua#e natural.
(ncorporar las me#ores prcticas de la codificacin.
2.1 Tipos de estndares de codificacin
)l momento de desarrollar los estndares de codificacin [[institucin]] debe tener en cuenta que
existen tres tipos de estndares y son los siguientes$
*andatarios
Pautas
+ecomendaciones
Para que los estndares sean tratados de forma seria" idealmente no deben ser extensos" y deben
ser de fcil acceso a todos los miembros del equipo" es necesario que ellos sean dados a conocer
antes de reali!ar la primera liberacin" en una reunin especfica para tal situacin que se debe
[[Nombre del Proyecto]]
[[Nombre de la institucin]] Pgina 1 de 2
[[Nombre del proyecto]]
Gua para Implementar Estndares de !odificacin.
[[fec"a]]
#ersin 1.$
[[Nombre de la institucin]]
Gua para Implementar Estndares de Codificacin [[Autor]]
Versin !"
llevar a cabo al inicio de [[Nombre del Proyecto]] y es absolutamente indispensable que se
encuentren todos los miembros de [[institucin]] presentes.
) continuacin se presentan algunos aspectos para la definicin de estndares de codificacin ,lo
que siguiente puede ser visto como un e#emplo" [[institucin]] deber escoger los estndares que
estime conveniente-$
.. Indentacin$ se/alar el espacio de la indentacin que tendr el cdigo a desarrollar.
0. !omentarios$ se/alar el formato de los comentarios para cada una de la funciones"
explicando por e#emplo que es lo que hace cada una de ellas.
1. Nombrado de los smbolos$ sera importante establecer un esquema para nombrar las
funciones" clases" atributos de las clases" parmetros" etc. y as evitar utili!ar nombres
establecidos en otras partes" adems de facilitar la lectura del cdigo.
2. Espacio dentro del cdi%o& para facilitar la lectura del cdigo" sera bueno se/alar un
espacio de separacin entre los diferentes elementos de ste.
[[Nombre del Proyecto]]
[[Nombre de la institucin]] Pgina 2 de 2

Вам также может понравиться