You are on page 1of 15

INTRODUCCIÓN

Diseñar o crear un software o aplicativo web no es un proceso que comienza en el


momento de la escritura del código, es una tarea que comienza mucho antes; es
decir, antes de que el código fuente del software sea escrito, el programador o
programadores deben saber este como que dará, cuál será la interfaz del mismo y
su funcionamiento.

De igual manera, es en estas etapas previas donde se establecen Estándares de


Codificación, que aunque no son obligatorios, si harán que la tarea de programar
sea más sencilla, eficiente y eficaz. Además, estos estándares permitiran que el
proceso de mantenimiento, de actualización y de corrección de errores de
ejecución sea una labor fácil de hacer, no solo para el o los programadores
involucrados en el trabajo de Dicho software, sino para otras personas que tengan
autorización para acceder al mismo.

Debido a las anteriores razones, en este trabajo se trataran temas como los que
siguen a continuación.

Estándares de Codificación

Algunos estándares de Codificación


 Variables y nombramiento de variables
 Funciones y nombramiento de Funciones
 Comentarios de Código, entre otros.
OBJETIVO GENERAL

Identificar las razones por las cuales el establecimiento de Estándares de


Codificación es una tarea vital en el momento de emprender la creación de un
Software o programa.

OBJETIVOS ESPECÍFICOS

 Enunciar los diferente Estándares de Codificación


JUSTIFICACIÓN
CONCLUSIÓN
ESTÁNDARES DE CODIFICACIÓN

¿Qué son?: son normas y reglas que convienen los programadores para
especificar como debe escribirse el Código Fuente y así evitar la incomprensión
del mismo, en procesos posteriores de mantenimiento, actualizaciones y
reparación de errores de ejecución. Por otro parte, vale la pena aclarar, que el
establecimiento de estándares de codificación no son de uso o de carácter
obligatorio, no obstante, son una herramienta útil para combatir un mal epidemial
que sucede en los mantenimientos, la dificultad para realizar los mismo de manera
eficaz y eficiente.

Vale la pena anotar, que el establecimiento de Estándares de Codificación hace


que los programadores de un proyecto trabajen de manera coordinada, tanto así
que parezca que el código fue escrito por un solo programador.

¿Por qué son importantes?

Los Estándares de Codificación, no pretende limitar al programador en su


creatividad, ni que su trabajo sea más arduo o difícil, antes por el contrario, buscan
que el codificar se vuelva más sencillo incluso se puede volver intuitivo, y en este
orden de idea, vale la pena resaltar las siguientes razones por la que los mismos
son muy importante al momento de escribir el código.

 Facilitan la escritura del código.

 Evita a que se comentan mayor cantidad de errores debido a malas


prácticas de programación.

 Facilitan la lectura (entendimiento) y, por tanto, permiten que los diferentes


desarrolladores puedan tratar cada porción del mismo como si de su propio
código se tratara (el código se convierte en algo que pertenece al equipo,
no a un desarrollador determinado, con sus manías y sus fobias).

 Permiten un mantenimiento eficaz y eficiente de la aplicación.

 Porque permite escribir un código uniforme en proyectos que envuelvan


un equipo de ingeniería completo.

 Mejoran la apariencia estética y profesional de producto de trabajo (por


ejemplo, al no permitir nombres excesivamente largos, nombres cómicos o
las abreviaturas).
 Ayudar a evitar "conflictos de nombres" que podrían ocurrir cuando se
combina el producto del trabajo de diferentes organizaciones

¿Qué convenciones o estándares se deben usar?

Depende del entorno de desarrollo que estés usando. No es lo mismo desarrollar


en Java, que para la plataforma .NET, que en Phyton... De todas formas, y como
consejo, se debe de tener en cuenta que las convenciones/estándares de la
industria son mejores que los de tu empresa, los de tu empresa son mejores que
los de tu proyecto, los de tu proyecto son mejores que tu estándar personal y este,
a su vez, siempre será mejor que no usar ninguna convención/estándar.

ALGUNOS ESTÁNDARES A TENER EN CUENTA AL MOMENTO DE


CODIFICAR

1. VARIABLES.

En programación, las variables son espacios reservados en la memoria que,


como su nombre indica, pueden cambiar de contenido a lo largo de la ejecución de
un programa. Una variable corresponde a un área reservada en la memoria
principal del ordenador.

NOMENCLATURA DE VARIABLES

Utilizar nombres de variables sencillos y comprensibles.

Es necesario nombrar las variables de manera que facilite la comprensión del


código fuente, manteniendo una cierta lógica dentro del modelo de negocio que
representan. Se utilizarán sustantivos escritos en minúsculas. Si el nombre de la
variable está formado por más de una palabra, a partir de la segunda palabra, la
primera letra de cada palabra deberá estar en mayúsculas. De esta manera, el
desarrollador obtendrá un código más intuitivo y sencillo de mantener.

De igual forma, para que nuestro código sea más entendible y claro, el
identificador de la variable debe ser mnemotécnico, es decir que debe reflejar el
uso dentro del programa de la misma.
REGLAS Y CONSEJOS PARA EL NOMBRAMIENTO DE VARIABLES

1. No puede tener el mismo nombre que una “palabra reservada” del


lenguaje.

Explicación: los lenguajes de programación tienen “palabras reservadas“, o sea


que esas palabras solo pueden ser usadas por el programa, por eso llevan el
nombre de “reservadas“, pues si supongamos el caso de que un lenguaje de
programación “X” tiene sus palabras reservadas.. Entre las cuales está: “ingresar“,
entonces eso quiere decir que el usuario NO debe declarar una variable con el
nombre “ingresar“, porque va a tener conflictos más adelante.

2. Sólo pueden ser letras, dígitos y el guión bajo o subguión.

Explicación: pues en los lenguajes de programación hay sintaxis que deben


cumplirse al pie de la letra, entonces dice que las variables solo pueden llevar
letras, numeros y el subguión, ejemplo:

La siguiente variable está bien declarada: programando19

La siguiente variable está mal declarada: %&programando-19

Vemos que insertó caracteres especiales, ademas de que uso el guión normal ( no
el subguión ), por lo tanto puede que el programa entienda que es una resta,
entonces está mal delcarado por sintaxis.

3. Deben comenzar por una caracter ( letra ).

Explicación: por sintaxis como ya hemos visto, deben cumplir con estas reglas,
entonces no se puede comenzar con un número, ya que se debe comenzar por
una letra como dice la regla, ejemplo:

La siguiente variable está bien declarada: pasoApaso

La siguiente variable está mal declarada: 89pasos

4. Deben iniciar con un caracter ( no numero ) como vimos en la regla 3, y


también puede comenzar con un guión bajo ( _ ), ejemplo:

La siguiente variable está bien declarada: _descuento

La siguiente variable está mal declarada: -descuento


La siguiente variable está mal declarada: descuento-

5. No se les pueden llevar espacios en blanco.

Explicación: las variables no pueden llevar espacios en blanco, solo pueden ser
separadas por un signo dedicado a ser usado como un espacio, el cual es el
subguión ( _ ), entonces en una variable cuando vean un subguión, practicamente
estan separando algo ( para que no parezca una ensalda ), ejemplo:

La siguiente variable está bien declarada: eddy_19

La siguiente variable está mal declarada: eddy 19

6. No pueden llevar acento ( tilde ), ejemplo:

La siguiente variable está bien declarada: numero

La siguiente variable está mal declarada: número

FUNCIONES

Las funciones son subprogramas que dependen del programa principal y que se
usan para realizar tareas independientes y específicas y pueden ser invocadas
desde la misma función o desde cualquier parte del programa las veces que sea
necesario.

Nombramiento de Funciones

Se deben nombrar funciones describiendo la acción que realizan mediante el uso


de verbos. La primera letra del nombre deberá estar en minúsculas. Si el nombre
está formado por más de una palabra, a partir de la segunda palabra la primera
letra deberá estar en mayúsculas.

Tipos de Funciones:

Existen dos tipos de funciones: sin parámetros y con parámetros.

Funciones sin parámetros:

Una función sin parámetros es aquella que no recibe variables de entrada para la
función. Se define de la siguiente forma:
Public Function suma() As Integer
Dim operacion As Integer
operacion = 5 + 5
Return operacion
End Function

Primero (opcional) comenzamos con determinar el nivel de acceso


(Private, Public, Friend, Etc). Luego la sentencia Function seguida por el nombre
de la función (En caso del ejemplo, se llama “suma”). Luego se especifica el tipo
de dato que retornará la función, sea texto, entero, decimal, Etc.

Como lo dijimos en la introducción, una función retorna un valor, en este caso, la


variable o el dato que se retornará se especifica luego de la sentencia “Return”. En
caso del ejemplo, vemos que se retorna la variable “operacion”, que a su vez
contiene la suma: 5 +5.

Cuando tengamos nuestra función creada, solo queda darle utilidad, y fácilmente
se hace de la siguiente forma:
TextBox1.Text = suma ()

Al hacer esto, el valor que retorno la función “suma”, será el que contendrá el
“TextBox1”:

FUNCIONES CON PARÁMETROS:

Una función con parámetros es aquella que recibe variables de entrada para la
función. Estas variables son procesadas y luego se retorna un único dato. Su
definición varia un poco, a diferencia de las funciones sin parámetros, estas se
definen de la siguiente forma:

Public Function suma(ByVal numero1 As Integer, BysVal numero2 As


Integer) As Double
Dim operacion As Integer
operacion = numero1 + numero2
Return operacion
End Function
Al comenzar notamos que su declaración varia un poco a diferencia de las
funciones que no reciben parámetros. Se comienza determinando el nivel de
acceso (Private, Public, Friend, Etc). Luego la sentencia Function seguida por el
nombre de la función (En caso del ejemplo, se llama “suma”). Luego de esto, se
crean las variables que nos funcionarán como parámetros con la sentencia “ByVal”
; los parámetros nos servirán para recibir datos locales del código que se
encuentra afuera de la función y procesarlos dentro de ella, en pocas palabras nos
sirven mandar información hacia la función.

Luego como en toda función con parámetros, procesamos los datos que
recibimos por parámetros, en este caso, la función la utilizamos de la siguiente
forma y pasaríamos nuestros parámetros así:

Dim num1 As Integer = 10


Dim num2 As Integer = 5
TextBox1.Text = suma(num1, num2)
.CONSTANTES

Nomenclatura de constantes

Nombrar las constantes siempre en mayúsculas.


Las constantes deben nombrarse todas en mayúsculas, separando las palabras
que formen parte del nombre con el carácter de subrayado (_)

Se deben evitar constantes numéricas sin mucho significado. Para eso es


conveniente definir las constantes en el programa. Todos los caracteres deben
estar en mayúsculas y las palabras separadas por "_".

Por ejemplo:

SI NO

define("EDAD_VOTACION”, "18");
... if (18<$edad)
if (EDAD_VOTACION <= $edad)

Nota: Nótese que es más natural preguntar


"$edad>=EDAD_VOTACION" que "EDAD_VOTACION <=
$edad", o "$i==0" que "0==$i", sin embargo la forma que
estamos utilizando es mucho más apropiada, ya que si por
casualidad, a uno se le olvida poner un doble igual (==) y se
utiliza un solo igual (=), el programa no va a dar un error, sino
que va a hacer algo completamente distinto a lo deseado. Por
eso, es muy buena práctica acostumbrarse a poner primero la
constante y luego la variable

COMENTARIOS DE CÓDIGO

Un comentario en programación es la línea de texto o nota incorporada en


nuestro código fuente que el compilador ignora.

Los comentarios en programación se utilizan para poner aclaraciones del código, y


así es más fácil de entender lo que hace, aunque también se utilizan para anular
parte de un código.

Los desarrolladores que han pasado tiempo en grandes proyectos comprenden


la importancia de tener comentarios de código.

No debería ser ninguna sorpresa, comentar tu código es esencial tanto en


proyectos en solitario como en equipo, sin embargo, muchos desarrolladores no
son conscientes de cómo hacer este proceso, yo he descrito algunos de mis
propios trucos personales para crear comentarios ordenados y claros. Normas
y plantillas de comentario variarán entre los desarrolladores pero en última
instancia se tratará de hacer los comentarios limpios y legibles para explicar
con más detalle las zonas confusas en el código.

No hay que olvidar que el código y sus comentarios forman un conjunto. Así
que debemos prestar la debida atención a ambos apartados. Para que nuestro
código sea elegante, limpio y fácil de mantener, podemos seguir los siguientes
consejos.

DIEZ CONSEJOS PARA MEJORAR LOS COMENTARIOS DE CÓDIGO DE


FUENTE

1. Utiliza nombres descriptivos

Es una regla básica, que aunque no está directamente relacionada con los
comentarios, influye mucho en ellos. Nuestras variables, clases y métodos, deben
tener un nombre descriptivo.
Lo normal es que los nombres de las clases sean sustantivos que representen una
entidad (Cliente, Proveedor etc.). Los métodos representan una acción, por lo que
su nombre suele contener algún verbo (devolverNuevoCliente, calcularPrecioTotal
etc.). Además deberemos intentar que las variables, propiedades y parámetros,
tengan un nombre que describa el valor que contienen (totalclientes,
totalpresupuesto etc.).

¿Qué conseguimos con esto? Pues además de un código fuente mucho más
legible, conseguimos reducir el número de comentarios necesarios. Por ejemplo:

var cliente = servicioClientes.recuperarDatosCliente(id_cliente);


if (cliente.estaActivo)
{
cliente.UlitmoAcceso=Date.Now;
servicioDatos.guardaCliente(cliente);
}
Al usar nombres descriptivos el código no necesita comentarios adicionales.
Cualquier programador que revise el código, será capaz de hacerse una idea de lo
que hace el código.

2. Los comentarios tienen que ser útiles

No hace falta explicar cosas obvias. El código fuente en el 98% de los casos lo va
a leer otro programador. O al menos alguien con conocimientos de programación.
Por ejemplo:

// Comprobamos si el contador es 5

if (contador == 5)
Ese comentario no aporta nada. Mejor si lo eliminamos. Mejor todavía si no
llegamos ni a escribirlo.

3. Piensa si un comentario es necesario antes de añadirlo

Si tenemos que añadir un comentario es mejor pensarlo un poco antes de hacerlo.


¿Por qué voy añadir este comentario? ¿Es realmente necesario? ¿Puedo
refactorizar mi código para evitarlo? Quizá el código que hemos escrito es
demasiado complejo y por eso necesita ser explicado. En ese caso podremos
separarlo en métodos más sencillos. Siempre siguiendo la norma de usar nombres
descriptivos.
Con esta simple idea, también podemos identificar posibles errores de diseño
4. Evita comentarios dentro de métodos o funciones

Puede ser útil comentar lo que hace un método antes de su declaración. Incluso
podemos comentar sus parámetros. Pero hay que tener en cuenta que debemos
comentar el "qué" y no el "cómo". Es decir, debemos explicar qué hace nuestro
método. El "cómo" hace el método su función ya va explicado en el código.

5. No comentes código eliminado

A veces nos vemos obligados a eliminar parte del código. Y a veces, en un


arranque de "por si acaso", comentamos el código eliminado, para no perderlo.
Esto es algo que no tiene sentido en el siglo XXI. Ya deberíamos tener un sistema
de control de código fuente para estas cosas. Y si no lo tenemos, tenemos
problemas más graves que los comentarios.

6. Piensa que los comentarios también hay que mantenerlos

Un comentario tiene que ser claro y explicar bien las cosas. Pero los comentarios
también hay que mantenerlos. Si describimos lo que hace un método, y en algún
momento la funcionalidad cambia, también tendremos que actualizar los
comentarios. Por tanto mejor que los comentarios sean breves y concisos.

7. Ten cuidado con los comentarios engañosos

Es algo que no suele hacerse a propósito, pero que puede darnos más de un
quebradero de cabeza. Tiene que ver con el punto anterior y el problema de no
mantener los comentarios. A veces porque nos dejamos algo por hacer, o por qué
una especificación ha cambiado, nuestro comentario queda obsoleto. O lo que es
peor, el comentario expresa algo distinto a lo que en realidad se está haciendo. Si
nos fiamos del comentario, podemos generar errores no esperados.

public int devolverEstadoCliente(){


// TO-DO
return 0;
}
Y luego en otra parte del código encontramos los siguientes
//Borramos el cliente si está desactivado
if (cliente.devolverEstadoCliente() == 0)
servicioDatos.borrarCliente(cliente);
En el ejemplo el problema se ve fácil porque el código está próximo. Pero si
tenemos el código repartido en distintas clases, podemos estar borrando cliente
sin querer.

8. Sigue siempre un mismo estilo

Es recomendable comentar el código siempre de la misma manera. Un estilo


definido ayuda a comprender el código a quién lo está leyendo. Si siempre
comentamos un método con una introducción y una descripción de los
parámetros, tendremos que ser constantes y hacerlo en todos los métodos. Si no
la persona que lo lea puede acabar confundido por la disparidad de criterios.

9. No dejes los comentarios para el final

En general a los que desarrollamos, no nos gusta comentar. Es algo aburrido, que
solemos dejar para más tarde. Pero procrastinar el comentado del código es una
mala idea por varias razones. La primera es que, al final, nos veremos obligados a
comentar un gran volumen de código de golpe. Eso es todavía más aburrido, y
nuestros comentarios serán peores. La segunda es que las ideas pierden frescura
según pasa el tiempo. Escribir comentarios de código que no acabamos de hacer
es más complicado y lleva más tiempo.

Mejor comenta a la vez que programas. O mejor, comenta antes de programar.


Escribiendo lo que tienes que hacer, tendrás una mejor comprensión del
problema.

10. Es mejor ser educado

Esto depende de un poco del ámbito del código fuente. En ámbitos laborales,
deberemos ser serios y correctos. Y más si el código es para un cliente. Si el
código lo estamos haciendo para nosotros, los comentarios pueden tener un tono
más distendido. Eso sí, mejor evitar palabras malsonantes, porque nunca se sabe
quién puede leer el comentario.

Conclusión

Desarrollar aplicaciones web y software es una práctica satisfactoria, aunque sea


difícil. Si eres uno de los pocos desarrolladores que realmente comprende la
construcción de software entonces es importante manejar comentarios para
aumentar sus habilidades de codificación. Dejar comentarios descriptivos es
sólo una buena práctica en el largo plazo, y es probable que ¡nunca te
arrepientas!

You might also like