AplicacionesWeb

Original de animalcrackers

1. Evita el Código Spaghetti
Para ello tienes que intentar modularizar tu código lo máximo posible, no meternos en grandes procedimientos difíciles llenos de código que no tiene

2. Practica la Indentacion
Un código bien tabulado es un código legible y modificable por nuevos desarrolladores.

3. Declaración de variables
No hay una norma con respecto a la declaración de variables pero conviene hacer unas cuantas apreciaciones.

Veamos un pequeño ejemplo:

Private Sub Prueba(ByVal j As String)
Dim i As New ObjetoNuestro
Try
Dim indice As Integer
For indice = j To 10
i.metodo(j)
Next
Catch ex As Exception
Throw ex
End Try
End Sub

A simple vista el código debe compilar y ser completamente correcto, pero podemos observar varias cosas:

- Los nombres de las variables no son descriptivas (i,j).
- Tendríamos que intentar en la medida de lo posible declarar las variables fuera del Try y luego “darles forma” hacer el casting dentro, para controlar un posible error.
- No es bueno declararnos las variables “según necesitemos” mejor tener las variables localizadas al principio de cada procedimiento.
- Intentar, en la medida de lo posible, hacer una distinción a la hora de nombrar las variables recibidas por parámetro de las declaradas dentro del procedimiento. Una forma sería poner un guión bajo (_) delante del nombre de las variables declaradas dentro de un procedimiento o función.
Hay un ejemplo que podría ilustrar la problemática de no desarrollar está técnica u otra similar

Public Class nombreClase
Dim _param As String
Dim param As String
Public Sub New(ByVal param As String)
Me._param = param
‘ojo esto sería valido también
Me.param = param
End Sub
End Class

Observemos la clase. Podemos ver que en constructor de la misma recibimos un parámetro que luego asignamos a una variable propia de la clase para posteriormente tratarla en otro procedimiento o lo que queramos. Pero si declaráramos la variable como en la segunda línea luego tendremos problemas para distinguirla (solo tenemos la posibilidad del Me, en este caso, pero del Me hablaremos otro día).

Con todo esto, el código quedaría de esta manera.

Private Sub Prueba(ByVal ValorAnual As String)
Dim _objNuestro As ObjetoNuestro
Dim indice As Integer
Try
_objNuestro = New ObjetoNuestro
For indice = ValorAnual To 10
_objNuestro.caculoSueldo(j)
Next
Catch ex As Exception
Throw ex
End Try
End Sub

4. Nomenclatura
Hay varios Standard, aquí os dejo un link muy interesante

5. Evitaremos los literales
No ayudan a un programador que venga nuevo

For i As Integer = 0 To 52 ‘ 52 no es descriptivo
Next

Usaremos constantes en la medida de lo posible.

Const _indiceSuperiorDerecho = 52
For i As Integer = 0 To _indiceSuperiorDerecho
Next

Asimismo, usaremos resultados de funciones o variables, algo descriptivo, para que los programadores que lleguen de nuevas puedan entender lo que hacemos.

6. Comentar el Código
Es conveniente comentar el código. Intentar poner un comentario al principio del procedimiento y solamente comentar cosas que creamos necesario aclarar. No comentar por comentar, como esto…

i = 11 ‘Asigno 11 a i
i++ ‘ Incremento en 1 a i

Articulos relacionados: