Documentar el código

Documentar el código

El código además de ser limpio, legible, entendible o estructurado entre otras características, debe estar muy bien documentado con el fin de efectuar un mantenimiento, modificación o ampliación de nuestra fuente. Además, es posible generar documentación en base a estos comentarios como es el caso de JavaDoc.

Existen muchas formas de comentar el código, por ejemplo:

C#, Java, PHP, etc.

  • Solo C#. Podemos hacerlo con tres barras /// en la que al crear una nueva línea, la siguiente línea queda también comentada con ///. Si las escribimos antes de una clase o un método, genera etiquetas de comentario que expondré a continuación.
  • Dos barras, crea una línea de código comentado
  • Comentario multilínea. Una barra y un asterisco /* provoca que el código esté comentado hasta que se cierre el comentario con asterisco barra */

Visual basic.NET

  • Comillas simples para comentar línea. ‘Esto es un comentario en VB.NET
  • Usar la etiqueta REM. REM Esto es un comentario en VB.NET
  • Si queremos crear varias líneas, debemos usar el concatenador guión bajo
    REM Esto es un comentario_ 
    en VB.NET

HTML

  • para cerrar el comentario

Comentarios de clases y métodos

Cuando estamos escribiendo código e instanciamos una clase o seleccionamos un método de una clase, los IDE,s nos muestran una ayuda que nos muestra que hace el método, que parámetros tiene o que sobrecargas y esto se consigue del siguiente modo:

C#

    • Escribimos /// precediendo a una clase o un método y se generan automáticamente una serie de etiquetas xml. La documentación de las etiquetas la pueden encontrar en el siguiente enlace.
      /// <summary>
      /// Obtiene el nombre completo del objeto Persona
      /// </summary>
      /// <param name="dni">DNI del objeto persona</param>
      /// <returns>Cadena de texto con el nombre completo</returns>
      public string GetFullName(string dni)
      {
      	return "Joaquín Martínez;
      }
      
      /// <summary>
      /// Obtiene el nombre completo del objeto Persona
      /// </summary>
      /// <param name="id">Identificador del objeto persona</param>
      /// <returns>Cadena de texto con el nombre completo</returns>
      public string GetFullName(int id)
      {
      	return "Joaquín Martínez;
      }
      

Java

    • Escribimos encima de un método /** e INTRO y se genera las etiquetas para documentar el código
      /**
      * Obtiene el nombre completo del objeto Persona
      * @param dni DNI del objeto persona
      * @return Cadena de texto con el nombre completo
      */
      public String getFullName(String dni){
      	return "Joaquín Martínez";
      }
      
      /**
      * Obtiene el nombre completo del objeto Persona
      * @param id Identificador del objeto persona
      * @return Cadena de texto con el nombre completo
      */
      public String getFullName(int id){
      	return "Joaquín Martínez";
      }
      

      coment04coment05

Regiones

Otra forma de mantener el código ordenado es mediante regiones, esto nos va a permitir por ejemplo mantener en una clase de negocio los métodos de actualización, adición y eliminación separados de los de selección, mantener propiedades en una región, campos en otra, métodos públicos en otra, privados en otra y así cuantas regiones queramos tener con el fin de mantener el código ordenado. Yo personalmente en una clase, generalizando, siempre tengo una región para constructores y destructores, una para enumeraciones, una para campos, una para métodos públicos y protected, otra para privados y si la clase es un form o window, añado una para controles y dentro de esta, por tipo de control, añado métodos de evento de cada uno, por ejemplo, Buttons, DataGrid, etc.

C#

#region Métodos públicos
        // aquí podemos poner todos los
        // miembros de clase que queramos
#endregion

VB.NET

#Region "Métodos Públicos"
' aquí podemos poner todos los
' miembros de clase que queramos
#End Region

def45-7-2-1
Java

// <editor-fold desc="Métodos públicos" defaultstate="collapsed">
        // aquí podemos poner todos los
        // miembros de clase que queramos
// </editor-fold>

coment06.png

Tareas

Visual Studio tiene comentarios de tareas, es decir si incluimos una serie de comentarios específicos (TOKEN) en alguna parte del código con un comentario adicional, en la lista de tareas, podemos acceder a esta localización de código para continuar con la tarea pendiente. Estos Token pueden personalizarse en el Menú Herramientas, Opciones, Lista de tareas. En este ejemplo, he colocado un TOKEN para revisar el contenido del método y en la lista de tareas, al hacer doble click, nos dirigiremos al código en cuestión.

coment07.png

Hay que añadir y es una buena costumbre, documentar las clases con autoría, fechas de creación y modificación, que hace la clase, que función tiene, las modificaciones que se han realizado, etc.

Hacedme caso, un poco tiempo perdido en documentar, nos hará ganar muchísimo tiempo en un futuro.

coment08.png

 

14.- Instrucciones de Salto

14.- Instrucciones de Salto
Hola a todos de nuevo. Hoy vamos a estudiar las instrucciones de salto. ¿Y que son las instrucciones de salto? Todos sabemos que en un programa las instrucciones se ejecutan secuencialmente, pues estas, nos permiten saltar de una parte del programa a otro evitando esa ejecución secuencial.Las instrucciones de salto para C# son:

  • break
  • continue
  • goto
  • return
  • throw

Y para VB.NET

  • Exit For
  • Exit Do
  • Exit While
  • Exit Select
  • Continue For
  • goto
  • Return

Paso a paso, vamos a detallar una por una excepto la última que la incluiremos en el tratamiento de errores.

La instrucción break nos permita terminar un bucle o salir de una instrucción switch, es decir por ejemplo, si creamos un bucle do while que vaya sumando 1 a una variable y le ponemos la condición de que cuando esa variable llegue a 100 salga del bucle, pues en la parte verdadera de esa condición es donde debemos poner el break, para que así salga y no siga sumando. Para VB.NET, se utiliza Exit For para un bucle For Next, Exit Do para un bucle Do While, Exit While para un bucle While y Exit Select para una instrucción Select Case. Como veis, C# se complica menos y utiliza break para todos los casos.

for (int i = 1; i <= 1000; i++)
{
	if (i == 100)
	{
		break;
	}
	Console.WriteLine(i);
}

Mismo caso pero con una instrucción while

int n = 0;
while (true)
{
	n += 1;
	if (n==100)
	{
		break;
	}
}

Y su equivalente para Vb.NET

        For i As Integer = 1 To 1000
            If i = 100 Then
                Exit For
            End If
            Console.WriteLine(i)
        Next
        Dim n As Integer = 0
        While True
            n += 1
            If n = 100 Then
                Exit While
            End If
        End While

continue, es una instrucción que no suelo utilizar a menudo, pero es curiosa en cuanto a su funcionamiento. Esta lo que provoca dentro de un bucle for o foreach, pasar a la siguiente iteración, por ejemplo.

            for (int i = 1; i <= 10; i++)
            {
                if (i < 9)
                {
                    continue;
                }
                Console.WriteLine(i);
            }

En este ejemplo cuando i es menor que 9 la instrucción continue evita que se escriba en la consola pasando a darle un valor nuevo a i hasta que i es mayor o igual a 9, donde entonces se imprimirá el valor en pantalla. Su equivalente en VB.NET es Continue For.

        For i As Integer = 1 To 10
            If i < 9 Then
                Continue For
            End If
            Console.WriteLine(i)
        Next

Goto transfiera o envía el control del programa a un sitio concreto del programa y ¿cómo sabe donde tiene que enviarlo?, pues porque en ese lugar debe existir una etiqueta. También puede usarse para transferir el control de programa a una etiqueta de una instrucción switch. Además, como es normal, podemos usarla también para salir de bucles, ¿no crees? Exponemos ejemplos. En el primero, aparecerá en pantalla ‘He salido’ cuando el valor de i valga 9.

C#

            for (int i = 1; i <= 10; i++)
            {
                if (i > 8)
                {
                    goto SalidaPrograma;
                }
            }
        SalidaPrograma:
            Console.WriteLine("He salido");

VB.NET


        For i As Integer = 1 To 10
            If i > 8 Then
                GoTo SalidaPrograma
            End If
        Next
SalidaPrograma:
        Console.WriteLine("He salido")

En el caso de salto dentro de una instrucción switch, lo vemos a continuación en el que dependiendo del valor de n, (el resto no me valen), en el que para el caso de 2 y 3, efectuará la suma propia del caso, pero además lo reenviará al valor 1 donde volverá a sumarle 25, ¿ok?
C#

            int valor=0;
            switch (n)
            {
                case 1:
                    valor += 25;
                    break;
                case 2:
                    valor += 25;
                    goto case 1;
                case 3:
                    valor += 50;
                    goto case 1;
                default:
                    Console.WriteLine("Esto no me vale");
                    break;
            }

VB.NET


        Dim valor As Integer = 0
        Select Case n
            Case 1
                valor += 25
                Exit Select
            Case 2
                valor += 25
             goto case 1
            Case 3
                valor += 50
             goto case 1
            Case Else
                Console.WriteLine("Esto no me vale")
                Exit Select
        End Select

La instrucción return acaba la ejecución del método donde se ha ejecutado y devuelve el control al método que llamó antes, además puede devolver algún valor. Con un ejemplo lo veremos con más claridad.

Si ejecutamos el método Inicio, se llamará al método CalcularAreaCirculo con un valor de radio igual a 5. Dentro del método de cálculo, se efectuarán los cálculos pertinentes para obtener el área y acto seguido se ejecuta return area, devolviendo el valor del área al método que lo llamó que es Inicio. Una vez este tiene el valor, lo visualiza en pantalla. Lo que si tenemos que tener en cuenta para VB.NET, es que para que un método devuelva un valor, debe ser una función (Function), cosa que en C# en vez de void se le asigna un tipo.

C#

            private void Inicio()
            {
                int radius = 5;
                double result = CalcularAreaCirculo(radius);
                Console.WriteLine("El area es {0:0.00}", result);
                Console.ReadKey();
            } 

            private double CalcularAreaCirculo(int r)
            {
                double area = r * r * Math.PI;
                return area;
            }

VB.NET

    Private Sub Inicio()
        Dim radius As Integer = 5
        Dim result As Double = CalcularAreaCirculo(radius)
        Console.WriteLine("El area es {0:0.00}", result)
        Console.ReadKey()
    End Sub

    Private Function CalcularAreaCirculo(r As Integer) As Double
        Dim area As Double = r * r * Math.PI
        Return area
    End Function

Pues esto es todo en cuanto a las instrucciones de salto, fácil, ¿no?. Pues nos vemos en la próxima entrega!!

Saludos “der Waki”

13.- Instrucciones de iteración

13.- Instrucciones de iteración

Por fin he vuelto. Estimados amigos, he tenido que dejar por una temporada el blog de Aprender a programar para mejorar mis conocimientos anglo-lingüísticos y me han absorbido todo el tiempo del mundo, pero a partir de ahora… si nada ni nadie lo impide, seguiremos en primera línea. Vamos allá.Bueno pues las instrucciones de iteración nos permiten repetir ciertas acciones o crear un bucle. Un bucle se puede repetir un número de veces limitado porque aunque se puede hacer ilimitado no tiene ningún sentido crear un programa que no acabe nunca, ¿no?. Dentro de estos bucles se ejecutan las instrucciones ordenadamente salvo cuando utilizamos otro tipo de instrucciones que son las de salto.

Tenemos varios tipos de instrucciones de salto y la primera de todas es do-while (hacer mientras…). Ahora vamos a ver un ejemplo para C# y su equivalente para VB .NET. Esta instrucción ejecuta un bloque de instrucciones repetidas veces hasta que una determinada instrucción se evalúa como false. Para C# el bloque de código se incluye entre llaves y acto seguido se incluye la expresión booleana. En el siguiente ejemplo creamos una pequeña aplicación que imprimirá por pantalla los valores desde 0 a 2. Como veis, al entrar en el bucle, se imprime el primer valor de x que es cero, después le suma a x una unidad (x++ esto de verdad que suma una unidad, es un operador y lo veremos en un futuro) , efectúa la comprobación x vale ahora 1, ¿1 es menor que 3?, si (true), pues volvemos al inicio del bucle do y se vuelve a ejecutar el mismo código hasta que x llega a tener el valor de 3 que en ese caso 3 no es menor que 3 y la expresión booleana sería false. En este momento, saldría del bucle. Para VB.NET es igual pero con Do y Loop While donde el contenido de código incluido entre ambas instrucciones, es lo que se ejecutará mientras la expresión While sea false. El aspecto fundamental de esta instrucción es que por lo menos, el bloque de código se ejecuta una sola vez ya que una vez ejecutado es cuando se comprueba la expresión booleana que permitirá seguir ejecutando este o salir del bucle.

C#

public class DoWhile_Prueba
    {
        public static void Main()
        {
            int x = 0;
            Console.WriteLine("SALIDA EN PANTALLA");
            do
            {
                Console.WriteLine(x);
                x++;
            } while (x &lt; 3);
            Console.WriteLine("FIN DE BUCLE");
        }
    }
    /* SALIDA EN PANTALLA:
      	0
        1
        2
    */

Vb.NET

Public Class DoWhile_Prueba
    Public Shared Sub Main()
        Dim x As Integer = 0
        Console.WriteLine("SALIDA EN PANTALLA")
        Do
            Console.WriteLine(x)
            x += 1
        Loop While x &lt; 3
        Console.WriteLine("FIN DE BUCLE")
    End Sub
End Class
'
'        SALIDA EN PANTALLA:
'        0
'        1
'        2

Ahora vamos a ver la instrucción while y su equivalente en VB.NET While y End While. En este tipo de instrucciones, la expresión booleana se verifica al principio, por tanto si al comienzo no se verifica la expresión , no se ejecutará ni una sola vez el contenido de código del bucle (esta es la principal diferencia con Do-While). Con esta instrucción, he incluido un cosita nueva, en la anterior instrucción metimos un operador de adición y en esta un parámetro. Cuando le damos formato a un texto como es en el siguiente caso, una vez vale una cosa y a la siguiente vale otra, bueno pues utilizamos unas llaves con un número en su interior y cuando se ejecute, se buscará por orden el primer parámetro disponible. Un ejemplo y lo entenderéis.

Console.WriteLine("Hola {0} {0}, me llamo {1} {2}, y esto es una {3}", "amigos", "Joaquín", "Martínez", "prueba");

{0} equivale a amigos, {1} a Joaquín, {2} a Martínez y {3} a prueba.
Esto imprimirá en pantalla “Hola amigos amigos, me llamo Joaquín Martínez y esto es una prueba”. Si os dais cuenta en cada hueco donde antes existía una llave y un número, ahora existe su equivalente en texto con el mismo orden en el que encontraba. Aunque no lo parezca, esto es muy útil!

C#

class WhileTest_Prueba
    {
        static void Main()
        {
     Console.WriteLine("Salida en pantalla")
            int n = 1;
            while (n < 6)
            {
                Console.WriteLine("Valor actual de n es {0}", n);
                n++;
            }
        }
    }
    /* Salida en pantalla:
        Valor actual de n es 1
        Valor actual de n es 2
        Valor actual de n es 3
        Valor actual de n es 4
        Valor actual de n es 5
     */

VB.NET

Class WhileTest_Prueba
    Private Shared Sub Main()
        Dim n As Integer = 1
        Console.WriteLine("Salida en pantalla")
        While n < 6
            Console.WriteLine("Valor actual de n es {0}", n)
            n += 1
        End While
    End Sub
End Class
'
'        Salida en pantalla:
'        Valor actual de n es 1
'        Valor actual de n es 2
'        Valor actual de n es 3
'        Valor actual de n es 4
'        Valor actual de n es 5

Ojo con este tipo de instrucciones porque SIEMPRE deben tener una salida, es decir que alguna vez se debe cumplir el valor de la expresión en false para poder salir del bucle, porque si no se convertiría en un bucle infinito sin ninguna utilidad. En el siguiente ejemplo ocurriría esto. Ya que el valor de nes 4 y la instrucción se ejecutará mientras que n sea mayor que 3, por tanto entraría en un bucle sin fin. Otra forma de salir de un bucle es mediante break, goto o return para C# o Exit While o Exit For, GoTo o Return.

C#

class WhileTest_Prueba
    {
        static void Main()
        {
            int n = 4;
            while (n > 3)
            {
                Console.WriteLine("Valor actual de n is {0}", n);
                n++;
            }
        }
    }

VB.NET

Class WhileTest_Prueba
    Private Shared Sub Main()
        Dim n As Integer = 1
        Console.WriteLine("Salida en pantalla")
        While n < 6
            Console.WriteLine("Valor actual de n is {0}", n)
            n += 1
            Return
        End While
    End Sub
End Class
'
'        Output:
'        Valor actual de n es 1
'        Valor actual de n es 2
'        Valor actual de n es 3
'        Valor actual de n es 4
'        Valor actual de n es 5

Otra instrucción de iteración, for para C# y For Next para VB.NET. Estas se ejecutan n-veces hasta que una expresión sea false y son muy útiles para recorrer matrices o para casos en los que conocemos el número de veces que se va a repetir un bucle. Por ejemplo vamos a ejecutar una instrucción 5 veces. La instrucción for realiza varias funciones. El primero y solo se hace una vez es declarar un variable i asignándole el valor de 1 (podríamos asignarle el valor 34 o -23), después la expresión de evaluación en este caso i<=5, es decirse ejecutará hasta que el valor de i sea menor o igual que 5 y por último el valor siguiente después de ejecutar el bloque que en este caso incrementa en 1 el valor de i (podríamos restarle 1 a i mediante –i o sumarle 2 mediante i+=2 aunque para VB.NET se utiliza Step.
Nota: La diferencia entre ++i y i++ es que la suma se realiza antes o después de asignarle un valor. Os muestro un ejemplo:

int i=3;
int j= ++i;
Console.WriteLine("Valor actual de j es {0}", j)
// Valor actual de j es 4;
i=3;
j= i++;
Console.WriteLine("Valor actual de j es {0}", j)
// Valor actual de j es 3;

Para VB.NET cerramos el bloque de código mediante la instrucción Next.
C#

class For_Prueba
    {
        static void Main()
        {
            Console.WriteLine("Salida");
            for (int i = 1; i <= 5; i++)
            {
                Console.WriteLine(i);
            }
        }
    }
    /* Salida:
    1
    2
    3
    4
    5
    */

Class For_Prueba
    Private Shared Sub Main()
        Console.WriteLine("Salida")
        For i As Integer = 1 To 5
            Console.WriteLine(i)
        Next
    End Sub
End Class
'
'    Salida:
'    1
'    2
'    3
'    4
'    5

Ejemplo de for obteniendo los números pares hasta 100
C#

for (int i = 1; i <= 100; i+=2)
{
       Console.WriteLine(i);
}

VB.NET

For i As Integer = 1 To 100 Step 2
       Console.WriteLine(i)
Next

Por último la instrucción foreach se utiliza para recorrer colecciones y ¿qué es una colección? Pues imaginemos que miramos la galería de fotos de nuestro móvil, seleccionamos una y vamos pasando una a una. Pues esto es lo que hace la instrucción foreach, pasar de una foto a otra por toda la colección.

¿Y qué hace? Pues el bloque de código contenido, se ejecutará para cada elemento de la colección. En el siguiente ejemplo, creamos una colección de números enteros y rotamos por cada uno de ellos. Como veis, esta instrucción tiene también varios elementos primero foreach, segundo y se ejecuta cada vez, crea un objeto del mismo tipo que los elementos de la colección y le asigna el valor de uno de estos y por último dice de donde debe extraer esos objetos. Pues para el siguiente caso se imprimirá por pantalla 0,1,1,2,3,5,8 y 13. Y a continuación expongo otra forma de recorrer una colección mediante una instrucción for diciendo que desde el valor con índice 0 hasta el valor menor que el número de elementos que tiene, imprima en pantalla el valor con el índice de la instrucción, curioso ¿no?

Para VB.NET foreach se convierte en For Each el valor del elemento declarado y la colección desde donde se extraerán los elementos acabando y cerrando el bloque de código con Next.
C#

int[] coleccion = new int[] { 0, 1, 1, 2, 3, 5, 8, 13 };
foreach (int element in coleccion)
{
         System.Console.WriteLine(element);
}
for (int i = 0; i < coleccion.Length; i++)
{
         System.Console.WriteLine(coleccion[i]);
}
/* En ambos casos, se imprime:
    0
    1
    1
    2
    3
    5
    8
    13
    */

Dim coleccion As Integer() = New Integer() {0, 1, 1, 2, 3, 5, 8, 13}
For Each element As Integer In coleccion
          System.Console.WriteLine(element)
Next
For i As Integer = 0 To coleccion.Length - 1
          System.Console.WriteLine(coleccion(i))
Next

Pues esto esto esto es todo amigos!!

Saludos “der Waki”

 

12.- Instrucciones de Selección

12.- Instrucciones de Selección
Las instrucciones son acciones que realiza el programa. Existen acciones comunes como la declaración de variables, la asignación de valores, la llamada a métodos, el recorrido en bucle de una colección y la creación de bifurcaciones a uno u otro bloque de código en función de una condición. El orden en que se ejecutan las instrucciones en un programa se denomina flujo de control o flujo de ejecución.Para C#, una instrucción puede estar compuesta por una única línea de código que finaliza en un punto y coma o por una serie de instrucciones de una línea incluidas en un bloque. Como ya hemos visto, un bloque de instrucciones se encierra entre llaves {} y pueden contener bloques anidados. A continuación enumero las categorías:

  • Instrucciones de selección (if, else, switch, case)
  • Instrucciones de iteración (do, for, foreach, in, while)
  • Instrucciones de salto (break, continue, default, goto, return, yield)
  • Instrucciones de control de excepciones (throw, try-catch, try-finally, try-catch-finally)
  • Checked y unchecked (checked, unchecked)
  • Instrucción fixed (fixed)
  • Instrucción lock

En VB.NET

En Visual Basic, una instrucción es una instrucción completa.  Puede contener palabras clave, operadores, variables, constantes y expresiones y cada instrucción como en C#, pertenece a cada una de las categorías siguientes:

Instrucciones de declaración, que dan nombre a una variable, constante o procedimiento y también pueden especificar un tipo de datos.

Instrucciones ejecutables, que inician acciones.  Estas instrucciones pueden llamar a un método o función, y pueden repetirse en bloques de código o crear una bifurcación en otro bloque de código. Las instrucciones ejecutables incluyen instrucciones de asignación, que asignan un valor o expresión a una variable o constante.

En este capítulo, vamos a ver las instrucciones de selección para C# y las instrucciones ejecutables para VB.NET.

¿Empezamos por C#? Venga, pues una instrucción de selección, hace que el programa vaya a un determinado punto dependiendo de que cierta condición sea verdadero o falso (true o false). Las palabras if, else, switch, case y default son las palabras clave en las instrucciones de selección. Como son palabras clave, no pueden usarse como variables o nombres de métodos ya que el compilador nos daría un error.

La instrucción if identifica que sentencia debe ejecutarse dependiendo de un valor booleano (verdadero o falso, true o false), vemos un ejemplo:

bool condition = true;
if (condition)
{
       Console.WriteLine("La variable tiene un valor true");
}
else
{
       Console.WriteLine("La variable tiene un valor false.");
}

Analicemos el código. Si la variable es true, (verdadera), visualizaremos en pantalla el texto de “La variable tiene un valor true”, pero si el valor lo cambiáramos a false, veríamos el segundo mensaje “La variable tiene un valor false”. El contenido donde se dirigirá el flujo del programa, se encuentra encerrado entre llaves {}, a continuación tenemos la palabra clave else y otras dos llaves con el contenido donde se redirigirá el programa cuando la condición es false.

En el siguiente ejemplo, declaramos una variable con valor entero y le asignamos el valor 8 y en la instrucción comparamos ese valor m para ver si es mayor que 10, ¿es mayor 8 que 10 (entre paréntesis)? Yo creo que no, pues entonces se aparecerá el mensaje “La variable tiene un valor false”.

int m = 8;
if (m > 10)
{
        Console.WriteLine("La variable tiene un valor true");
}
else
{
        Console.WriteLine("La variable tiene un valor false.");
}

También podríamos comparar si un texto es igual a otro mediante el operador ==

string texto = “mi_texto”;
if (texto == “mi_texto”)
{
	Console.WriteLine("La variable tiene un valor true");
}

También existe una combinación de if else y es que además podemos hacer una comparativa if y si falla esta, podemos hacer de nuevo otra comparación else if y si fallaran todas las instrucciones else if, redirigir el programa a la instrucción else.

int m = 8;
if (m > 10)
{
	Console.WriteLine("La variable tiene un valor true");
}
else if (m == 8)
{
	Console.WriteLine("La variable tiene un valor igual a 8");
} 
else
{
	Console.WriteLine("La variable tiene un valor false.");
}

La instrucción if tiene una forma simplificada como la que os represento

if (m > 10) {Console.WriteLine("La variable tiene un valor true");}
else {Console.WriteLine("La variable tiene un valor false.");}

(Esta versión es igual que las anteriores, pero con las llaves en la misma línea)
o

if (m > 10) Console.WriteLine("La variable tiene un valor true");
else Console.WriteLine("La variable tiene un valor false.");

Consejo: cuando no sepáis como funciona una instrucción, acudid a la referencia de msdn, ahí tenéis todo.

Otra instrucción de selección es switch en la que se redirige el programa a la lista de candidatos, en el siguiente caso, como es igual a 1, se redirigirá a la zona donde se imprimirá en pantalla “Caso 1”. Si por ejemplo el valor de la variable tuviera un valor de 17, como no existe ningún caso que valga 17, se ejecutaría la instrucción Default.

La palabra clave break, hace que una vez ejecutado el caso concreto, el programa se redirija fuera de la instrucción y no ejecute nada más dentro de esta.

int casoSwitch = 1;
switch (casoSwitch)
{
            case 1:
                Console.WriteLine("Caso 1");
                break;
            case 2:
                Console.WriteLine("Caso 2");
                break;
            default:
                Console.WriteLine("Caso Default");
                break;
}

En el lenguaje “der Waki”. ¿Existe algún caso que sea igual a 2? Pués claro!! Ir hasta el caso 2 e imprimir en pantalla “Caso 2”.

Otro caso, sería poder agrupar casos. En este concreto, hemos agrupado el caso 2,3 y 8, de modo que si la variable vale alguno de ellos, aparecerá el texto “Caso 2, 3 u 8”

        int casoSwitch = 3;
        switch (casoSwitch)
        {
            case 1:
                Console.WriteLine("Caso 1");
                break;
            case 2:
            case 3:
            case 8:
                Console.WriteLine("Caso 2, 3 u 8");
                break;
            default:
                Console.WriteLine("Caso Default");
                break;
        }

En Visual Basic .NET es muy parecido todo, pero existen algunas variaciones, primero que no existen llaves como en C#, estas se cambian por palabras clave, entonces para iniciar una instrucción if, esta comienza por lo mismo If, se añade la condición (sin paréntesis), palabra clave Then (entonces en inglés), el contenido del código que se ejecutará cuando sea verdadero, ElseIf o Else cuando queremos efectuar nuevas comparativas o la condición es falsa respectivamente y por fin le decimos al compilador que la instrucción finaliza con End If. ¿Bien? Prácticamente es igual!

Dim m As Integer = 8
If m > 10 Then
	Console.WriteLine("La variable tiene un valor true")
ElseIf m = 8 Then
	Console.WriteLine("La variable tiene un valor igual a 8")
Else
	Console.WriteLine("La variable tiene un valor false.")
End If

Para la instrucción switch iniciamos con Select Case y expresión Switch. Luego los casos, código del caso y salida de la instrucción Select Case.

Dim casoSwitch As Integer = 3
Select Case casoSwitch
	Case 1
		Console.WriteLine("Caso 1")
		Exit Select
	Case 2, 3, 8
		Console.WriteLine("Caso 2, 3 u 8")
		Exit Select
	Case Else
		Console.WriteLine("Caso Default")
		Exit Select
End Select

Igual pero con otras palabras!! Same, but with other words!!
Y si encima .NET, te permite escribir en varios lenguajes, pues que más da el que uses!! el que más fácil te resulte, ¿no?

Saludos “der Waki”

Nota: Si utilizáis Visual Studio, escribid dentro de un método la palabra if y pulsáis la tecla TAB dos veces. OHHH!! el fragmento de código, se escribe solo!!!

11.- Los campos, variables locales y tipos.

11.- Los campos, variables locales y tipos.
Vamos a tratar los campos, las variable locales y los tipos mediante una «minientrega».Los campos, como ya dijimos, son variables declaradas a nivel de clase. Estos campos tienen como es lógico sus modificadores, es decir, pueden ser public, protected, prívate.

Aconsejo, no usar los campos como públicos sino privados o protegidos. ¿Por qué? Pues porque para ello ya usamos las propiedades y el campo lo que hace es respaldar el almacenamiento de estas.

Bueno hasta ahora no hemos descubierto nada, puesto que es repaso de lo aprendido, cuando declaramos un campo, lo definimos con un tipo, un número entero, doble precisión, fecha, cadena de texto, etc. Estos tipos pueden convertirse entre unos y otros, siempre que el compilador pueda hacerlo, en caso contrario provocaría un error. Puedo convertir una fecha a texto, pero lo que no puedo hacer es convertir la palabra “hola” en una fecha, el compilador se quejaría, ¿no?.

Una vez declarada una variable, ésta no se puede volver a declarar con un nuevo tipo y tampoco se le puede asignar un valor que no sea compatible con su tipo declarado. Por ejemplo, no puede declarar int y a continuación, asignarle un valor booleano de true. Sin embargo, los valores pueden convertirse en otros tipos, por ejemplo, cuando se asignan a variables nuevas o se pasan como argumentos de método.

Los tipos son:

Nombre de tipo
Descripción
System.Object
Clase base para todos los tipos. Puede almacenar cualquier cosa
System.String
Cadena de texto.
System.SByte
Byte con signo de 8 bits.
System.Byte
Byte sin signo de 8 bits.
System.Intl6
Valor de 16 bits con signo.
System.Ulntl6
Valor de 16 bits sin signo.
System.Int32
Valor de 32 bits con signo.
System.Ulnt32
Valor de 32 bits sin signo.
System.Int64
Valor de 64 bits con signo.
System.Ulnt64
Valor de 64 bits sin signo.
System.Char
Carácter unicode de 16 bits.
System.Single
Valor en coma flotante del IEEE de 32 bits.
System.Double
Valor en coma flotante del IEEE de 64 bits.
System.Boolean
Valor booleano (true!false).
System.Decimal
Tipo de
datos de 128-bit igual a 28 o 29 dígitos. Principalmente utilizado para aplicaciones
financieras, donde se requiere un alto grado de precisión.

Todos los tipos tienen un alias en el lenguaje de programación usado. ¿Y que es un alias?, pues un modo abreviado de acceder a ellos de una forma más rápida. Estos alias o nombres, no pueden ser utilizados para nombrar variables, están protegidos por el compilador, de modo que si intento declarar una variable con el nombre double, el compilador chillaría!

Y ¿por qué el tipo? Pues entre otras cosas, el tipo determina el almacenamiento interno en la memoria donde se guarda esta variable, el valor máximo y mínimo que puede representar, los miembros de clase que contiene (porque son clases), los tipos de operaciones que se pueden realizar con ellas, el tipo del que hereda y la ubicación en la memoria cuando se están en tiempo de ejecución. Con todo esto, el compilador se encarga de de comprobar que todos hacen las cosas como deben hacerlas.

Ejemplo.

C#

int a = 5;
int b = a + 2; //Esto funciona, suma 5 + 2 = 7
bool test = true;
int c = a + test; // Error. El operador '+' no puede sumar una variable de número con una variable tipo booleana.
string d = a.ToString() + test.ToString(); // Esto no da error ya que el resultado es ‘5True’, ahora las variable tipo número y booleana, las he convertido antes a texto y lo que ha hecho, ha sido concatenarlas

VB.NET

Dim a As Integer = 5
Dim b As Integer = a + 2
'Esto funciona, suma 5 + 2 = 7
Dim test As Boolean = True
Dim c As Integer = a + test
' Error. El operador '+' no puede sumar una variable de número con una variable tipo booleana.
Dim d As String = a.ToString() & test.ToString()' Esto no da error ya que el resultado es ‘5True’, ahora las variable tipo número y booleana, las he convertido antes a texto y lo que ha hecho, ha sido concatenarlas

No se si os habéis dado cuenta, pero cuando declaramos una variable con su tipo, en la misma declaración es posible asignarle un valor, de este modo no tenemos porque volver a escribirla y asignarle un valor.

Bueno, pues todas estas cosas, además las podemos realizar dentro de un método y en este caso, la variable se convierte en local del método y no es accesible nada más que dentro de este y tampoco, nos permitirá declarar una variable con el mismo nombre dentro del método.

¿Cuáles son los más utilizados? Pues depende para que los vayamos a usar; ahí viene cuando diseñamos la clase y debemos determinar qué valores van a usar los miembros de clase.

Por ejemplo, dentro de un método voy a incluir un contador dentro de un bucle y cada vez que se repita, se sumará la cantidad de 1; sé que “jamás” no sobrepasará el valor de 10000, vamos que no llegará al valor de 10000, pues creo que si declaro una variable de tipo entero (16 bit) será más que suficiente, (valor mínimo -2147483647 y máximo 2147483647 ala!!!) ahora si el valor que voy a almacenar es el resultado de una división y necesito un aproximación alta, utilizaré un doublé (valor mínimo 5,0×10-324 y valor máximo 1,7×10308. Vaya cifras astronómicas!, ¿no? pues depende para que, a veces se quedan cortas.

Pues lo prometido es deuda, entrega corta y a programar!! Practicad mucho!!

Saludos “der Waki”

10.- Las propiedades

10.- Las propiedades
Como ya dijimos, las propiedades es una mezcla entre método y campo, puesto que almacenan valores y además nos permiten hacer cálculos sobre ellos. Para el que accede a la propiedad, la ve como un campo.
Además, son miembros de clase que nos permiten leer, escribir o calcular un campo privado de la clase, es decir, nos permite leerlo, cambiarle su valor o calcularle uno nuevo.
Una propiedad genérica, tiene la siguiente estructura:

  • Contiene un descriptor Get. Se utiliza para leer la propiedad. Una propiedad sin este valor, se considera de solo escritura, puesto que no es posible leerla.
  • Contiene un descriptor Set. Se utiliza para asignar un valor a la propiedad. Si este descriptor no existiera, la propiedad sería solo de lectura y por tanto, sería como cuando vimos la constante, que era un campo de solo lectura.
  • Tiene un campo del mismo tipo que la propiedad y asociado a esta.

Las propiedades no son campos, por tanto no podemos pasar como argumento en un método una propiedad.

¿Qué usos le podemos dar a las variables? Pues podemos usarlas para validar datos antes de permitir un cambio, exponer los datos de forma transparente obtenidos desde otro origen o cuando se realiza una acción, por ejemplo si cambiamos su valor, se genera un evento avisándonos de que la propiedad ha cambiado.

¿Dónde se declaran las propiedades? Las propiedades se declaran a nivel de clase mediante el tipo, el nombre de la propiedad, el descriptor get y el descriptor set.

Ejemplo. En la siguiente propiedad, declaramos un campo month y le asignamos el valor 7. Acto seguido declaramos la propiedad pública Month y en la cual si nosotros solicitáramos su lectura, nos daría el valor del campo month, en este caso, nos daría el valor 7. Si dijéramos que la propiedad Month vale ahora 10 (Octubre), en el descriptor set, comprobaría que el valor que le pasamos es mayor que 0, que como mínimo vale 1 y menor que 13, que como máximo valga 12. Una vez efectuada la comprobación le asignaría el valor a la propiedad. ¿Qué ocurriría si le asignamos el valor 15? Pues como no cumple las condiciones de mayor de 0 y menor de 13 y no se asignaría ningún valor a la propiedad quedando en su estado anterior. El valor value, es el valor que asignamos a la propiedad. ¿bien?

C#

    private int month = 7;  // el campo month
    public int Month    // La propiedad Month
    {
        get
        {
            return month;
        }
        set
        {
            if ((value > 0) && (value < 13))             {                 month = value;            
        }         
    }     
} 

VB.NET

 
Private m_month As Integer = 7' el campo month
Public Property Month() As Integer' La propiedad Month
 		Get
 			Return m_month
 		End Get
 		Set(value As Integer)
 			If (value > 0) AndAlso (value < 13) Then
				m_month = value
			End If
		End Set
End Property

Otro ejemplo con nuestra clase preferida, la clase Vehiculo. Asignamos un propiedad a esta clase llamada Matricula y otra Potencia, pues vamos a crear una instancia de esta y vamos a leer y escribir sus propiedades.
C#

static void Main(string[] args)
{
     Console.WriteLine ("Comienza la App");
     Vehiculo miVehiculo = new Vehiculo();
     miVehiculo.Potencia = 120;
     miVehiculo.Matricula = "0000 XXX";
     Console.WriteLine(miVehiculo.Potencia);
     Console.WriteLine(miVehiculo.Matricula);
     Console.WriteLine("Pulse INTRO para finalizar..");
     Console.ReadLine();
} 

class Vehiculo
{
        public Vehiculo()
        {
            // código utilizado al instanciar la clase
        }
        private double _potencia;
        public double Potencia
        {
            get { return _potencia; }
            set { _potencia = value; }
        } 

        private string _matricula;
        public string Matricula
        {
            get { return _matricula; }
            set { _matricula = value; }
        }
}

VB.NET


Private Shared Sub Main(args As String())
       Console.WriteLine("Comienza la App")
       Dim miVehiculo As New Vehiculo()
       miVehiculo.Potencia = 120
       miVehiculo.Matricula = "0000 XXX"
       Console.WriteLine(miVehiculo.Potencia)
       Console.WriteLine(miVehiculo.Matricula)
       Console.WriteLine("Pulse INTRO para finalizar..")
       Console.ReadLine()
End Sub  

Private Class Vehiculo

       Public Sub New()
           ' código utilizado al instanciar la clase
       End Sub

       Private _potencia As Double
       Public Property Potencia() As Double
            Get
                 Return _potencia
            End Get
            Set(value As Double)
                _potencia = value
            End Set
       End Property
       Private _matricula As String
       Public Property Matricula() As String
            Get
                Return _matricula
            End Get
            Set(value As String)
                _matricula = value
            End Set
       End Property
End Class

En este ejemplo, desde el método de clase Main, creamos un objeto Vehículo llamado miVehiculo, le asignamos a la propiedad Potencia un valor de 120 , a la propiedad de Matrícula 0000 XXX y una vez asignadas, las imprimimos por pantalla.
¿Qué ocurre dentro de las propiedades? Cuando le asignamos un valor a la Propiedad Potencia, estamos accediendo al descriptor set dándole al valor del campo _potencia, el valor asignado de 120 pero en el siguiente paso, cuando lo imprimimos por pantalla accedemos al descriptor get y este lo que hace es ir a buscar el campo privado de clase _potencia y devuelve su valor que es 120. Así de fácil.

Otro ejemplo un poco más complejo.
C#

class Cuadrado
    {
        public double _lado;
        public Cuadrado(double s)  //constructor
        {
            _lado = s;
        }
        public double Area
        {
            get
            {
                return _lado * _lado;
            }
            set
            {
                _lado = System.Math.Sqrt(value);
            }
        }
        public double Volumen
        {
            get { return _lado * _lado * _lado; }
            set { _lado =System.Math.Pow( value, 1 / 3); }
        } 

static void Main(string[] args)
{
      Cuadrado MiCuadrado = new Cuadrado(4);
      Console.WriteLine(MiCuadrado.Area); // imprime por pantalla 16
      MiCuadrado.Area = 100; // ahora el lado vale 10, pero no lo vemos porque es un camp privado de clase
      Console.WriteLine(MiCuadrado.Volumen); // imprime por pantalla 1000
 }

VB.NET

Class Cuadrado
        Public _lado As Double
        Public Sub New(s As Double)
           'constructor
            _lado = s
        End Sub
        Public Property Area() As Double
            Get
                Return _lado * _lado
            End Get
            Set(value As Double)
                _lado = System.Math.Sqrt(value)
            End Set
        End Property
        Public Property Volumen() As Double
           Get
                Return _lado * _lado * _lado
           End Get
           Set(value As Double)
               _lado = System.Math.Pow(value, 1 \ 3)
           End Set
        End Property
End Class

Private Shared Sub Main(args As String())
            Dim MiCuadrado As New Cuadrado(4)
            Console.WriteLine(MiCuadrado.Area)
            ' imprime por pantalla 16
            MiCuadrado.Area = 100
            ' ahora el lado vale 10, pero no lo vemos porque es un camp privado de clase
End Sub

Creamos una clase Cuadrado a la cual le agregamos una propiedad llamada Area con un campo llamado _lado. En el constructor de la clase, (lo primero que hace una clase cuando se instancia), le agregamos un parámetro s, de modo que cuando instanciemos la clase Cuadrado, nos pedirá que le pasemos un argumento, en este caso el valor del lado el cual automáticamente es asignado al campo _lado. Hasta aquí todo bien.

Si le pedimos al objeto cuadrado el valor de su Area, el descriptor get, obtendrá el valor de _lado y lo multiplicará por si mismo, obteniendo el Area que solicitamos.

Si ahora le dijéramos a este objeto que el valor de su Area es 100, el descriptor set calcularía la raíz cuadrada del área para asignar al campo _lado este valor, en este caso 10, por tanto al solicitarle que imprima por pantalla la propiedad Volumen, este ha calculado el nuevo valor del lado y el nuevo valor del volumen. Este es uno de los poderes secretos de las propiedades. Fantástico ¿no?

Ahora que sabemos que son las propiedades, más adelante crearemos algunas más complejas que nos avisen cuando cambie su valor generando eventos.

Saludos “der Waki”

9.- Los métodos

9.- Los métodos
Como dijimos, los métodos son las acciones realizadas por el objeto. En la cuarta entrega, escribíamos con el “lenguaje der Waki” la clase Vehículo con los métodos Avanzar, Arrancar o Parar. En el método Avanzar le añadíamos la velocidad hasta la que queríamos que nuestro vehículo llegara.
El valor velocidad es el parámetro del método, es el que aparece en el método, mientras que el argumento es el valor pasado una vez creado el objeto. Ejemplo.
C#


/* ************************************************
* © WAKI 2014
* PROYECTO:        Aprender a Programar.
* Archivo:         Program.cs
* Descripción:     Clase Main y Vehículo
* Historial:
* Comentarios:
*
****************************************************/
using System;
namespace MyNameSpace
{
    class MyApp
    {
        static void Main(string[] args)
        {
            Console.WriteLine ("Comienza la App ==>");
            Vehiculo miVehiculo = new Vehiculo();

            miVehiculo.Avanzar(50); // esto hace avanzar el vehículo hasta los 50km/h. 50 es el ARGUMENTO
            Console.WriteLine ("Pulse una tecla para frenar el vehículo...");
            Console.ReadLine();
            miVehiculo.Avanzar(0); // esto hace parar. 0 es el ARGUMENTO
            Console.WriteLine("Pulse INTRO para finalizar..");
            Console.ReadLine();
       }
    }
    class Vehiculo
    {
        public Vehiculo()
        {
            // código utilizado al instanciar la clase
        }
        public void Avanzar(int kmHora)
        {
            // kmHora es el parámetro tipo número entero del método Avanzar
            Console.WriteLine("La velocidad del vehículo es de " + kmHora.ToString() + " km/h");
        }
    }
}

VB.NET

' ************************************************
'* © WAKI 2014
'* PROYECTO:        Aprender a Programar.
'* Archivo:         Program.cs
'* Descripción:     Clase Main y Vehículo
'* Historial:
'* Comentarios:
'*
'***************************************************
Namespace MyNameSpace
    Class MyApp
        Private Shared Sub Main(args As String())
            Console.WriteLine("Comienza la App ==>")
            Dim miVehiculo As New Vehiculo()

            miVehiculo.Avanzar(50)
            ' esto hace avanzar el vehículo hasta los 50km/h. 50 es el ARGUMENTO
            Console.WriteLine("Pulse una tecla para frenar el vehículo...")
            Console.ReadLine()

            miVehiculo.Avanzar(0)
            ' esto hace parar. 0 es el ARGUMENTO
            Console.WriteLine("Pulse INTRO para finalizar..")
            Console.ReadLine()
        End Sub
    End Class

    Class Vehiculo
        ' código utilizado al instanciar la clase
        Public Sub New()
        End Sub

        Public Sub Avanzar(kmHora As Integer)
            ' kmHora es el parámetro tipo número entero del método Avanzar
            Console.WriteLine("La velocidad del vehículo es de " & kmHora.ToString() & " km/h")
        End Sub
    End Class
End Namespace

Analizando código…

  1. Escribimos en la consola “Comienza App ==>”
  2. Creamos el objeto miVehiculo
  3. Llamamos al método Avanzar de miVehículo pasando el argumento 50
  4. Se visualiza en la consola “La velocidad del vehículo es de 50 Km/h”
  5. Escribimos en la consola “Pulse una tecla para frenar el vehículo…”
  6. Al pulsar INTRO, llamamos de nuevo al método Avanzar de miVehículo pasando el argumento 0
  7. Se visualiza en la consola “La velocidad del vehículo es de 0 Km/h”
  8. Al pulsar INTRO finalizamos.

Nota: Solo hay detalle nuevo que se nos pasa por alto y es
que en C# ¿se suman las palabras?. El texto se concatena en C# mediante el
signo + mientras que en VB.NET es mediante el signo &. Estos son operadores
y los hay a miles (no tantos Waki!).
Un método puede contener múltiples parámetros y de cualquier índole. Podría crear una clase a la
que pasará como un argumento un objeto tipo Vehículo, cualquier objeto admite,
ahora si, si la clase o el método tiene como parámetros un objetos tipo
Vehículo, solo y exclusivamente podemos pasarle este tipo de objeto y no un
número del tipo int, Integer o entero, un string o cadena, o booleano, etc
Más cosas con los métodos, podemos crear métodos con el mismo nombre pero con distinto tipo de parámetros.  Esto se llama sobrecarga y permite utilizar un
mismo método de diferente forma como en la vida misma o ¿nosotros caminamos siempre del mismo modo?,  a pesar de que
el método caminar es el mismo, podemos hacerlo calzados o descalzados (con lo que variaría la velocidad), el tipo de calzado, hacia atrás, hacia adelante,
etc. Expongo un ejemplo.
C#

public void Avanzar(int kmHora)
{
      // kmHora es el parámetro tipo número entero del método Avanzar
      Console.WriteLine("La velocidad del vehículo es de " + KmHora.ToString() + " km/h");
}

public void Avanzar()
{
     // avanza hasta los 50 Km/h como valor predeterminado
     Console.WriteLine("La velocidad del vehículo es de 50 km/h");
}

public void Avanzar(int kmHora, bool limitarA120)
{
	// kmHora es el parámetro tipo número entero del método Avanzar
	// limitarA120 no permite que pase de 120 km/h
	if (limitarA120 && kmHora > 120)
	{
		kmHora = 120;
	}
       Console.WriteLine("La velocidad del vehículo es de " + kmHora.ToString() + " km/h");
}

VB.NET

Public Sub Avanzar(kmHora As Integer)
    ' kmHora es el parámetro tipo número entero del método Avanzar
    Console.WriteLine("La velocidad del vehículo es de " & kmHora.ToString() & " km/h")
End Sub

Public Sub Avanzar()
    ' avanza hasta los 50 Km/h como valor predeterminado
    Console.WriteLine("La velocidad del vehículo es de 50 km/h")
End Sub

Public Sub Avanzar(kmHora As Integer, limitarA120 As Boolean)
    ' kmHora es el parámetro tipo número entero del método Avanzar
    ' limitarA120 no permite que pase de 120 km/h
    If limitarA120 AndAlso kmHora > 120 Then
        kmHora = 120
    End If
    Console.WriteLine("La velocidad del vehículo es de " & kmHora.ToString() & " km/h")
End Sub

Tres métodos Avanzar pero con distintos parámetros. El primero permite llevar al vehículo a una velocidad concreta, el segundo lleva al vehículo a una velocidad predeterminada y el tercero lleva un parámetros que nos va a permitir limitar la velocidad a 120 Km/h. Si el segundo argumento pasado (parámetro limitarA120), tiene un valor false, (falso), se comporta como el método primero, pero si el argumento pasado tiene un valor true, (verdadero), el método limitará la velocidad a 120. ¿Cómo? Mediante el fragmento if o If…

La instrucción if para C# o If…Then para VB.NET tiene muchas variantes, pero esta es la más sencilla. Lo primero que hace es efectuar una comparación booleana, quiere decir que se obtendrá un Sí o un No, un Verdadero o un Falso, un true o un false. Dentro de esta condición hacemos otra comparación mediante el operador && o AndAlso que es el operador equivalente a decir Y; en el método preguntamos, ¿es verdadero el argumento pasado limitarA120? Y además ¿es verdadero que el argumento pasado de velocidad es mayor que 120? Pues si esto es verdadero, se limitará la velocidad a 120 Km/h, pero si alguno de las condiciones de la instrucción if no se cumple, el argumento limitar es falso o la velocidad es inferior a 120, pues no se limitará. ¿OK? Pues tan útil como ya he dicho se llama sobrecarga de métodos.

Por último, los métodos también pueden devolver valores. Si le pedimos a una calculadora que sume dos número, primero nos solicitará los dos números y luego el método suma, devolverá un resultado con las dos cantidades sumadas, bien, pues a un método por ejemplo le pasamos dos argumentos y este, devuelve la suma de ambos. En VB.NET los métodos que devuelven valores se llaman funciones. Ejemplos es lo que nos hace falta!. Vamos a convertir los tres métodos del ejemplo anterior pero devolviendo el texto que escribimos en la consola, evitando incluir Console.WriteLine en cada método.

C#

/* ************************************************
* © WAKI 2014
* PROYECTO:        Aprender a Programar.
* Archivo:         Program.cs
* Descripción:     Clase Main y Vehículo
* Historial:
* Comentarios:
*
****************************************************/

using System;
namespace MyNameSpace
{
    class MyApp
    {
        static void Main(string[] args)
        {
            Console.WriteLine ("Comienza la App");
            Vehiculo miVehiculo = new Vehiculo();
            string textoDeSalida = miVehiculo.Avanzar(90); // esto hace avanzar el vehículo hasta los 90km/h. 90 es el ARGUMENTO
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine ("Pulse una tecla para frenar el vehículo...");

            Console.ReadLine();
            textoDeSalida = miVehiculo.Avanzar(0); // esto hace parar. 0 es el ARGUMENTO
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine("Pulse una tecla para activar velocidad predeterminada...");
            Console.ReadLine();

            textoDeSalida = miVehiculo.Avanzar(); // esto hace parar. 0 es el ARGUMENTO
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine("Pulse una tecla para limitar velocidad...");
            Console.ReadLine();

            textoDeSalida = miVehiculo.Avanzar(150,true); // velocidad a 150 km/h y limitador activado
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine("Pulse INTRO para finalizar..");
            Console.ReadLine();
        }
    }

    class Vehiculo
    {
        public Vehiculo()
        {
            // código utilizado al instanciar la clase
        }

        public string Avanzar(int kmHora)
        {
            // kmHora es el parámetro tipo número entero del método Avanzar
            return "La velocidad del vehículo es de " + kmHora.ToString() + " km/h";
        } 

        public string Avanzar()
        {
            // avanza hasta los 50 Km/h como valor predeterminado
            return "La velocidad del vehículo es de 50 km/h";
        } 

        public string Avanzar(int kmHora, bool limitarA120)
        {
            // kmHora es el parámetro tipo número entero del método Avanzar
            // limitarA120 no permite que pase de 120 km/h
            string textoDeSalida = "La velocidad del vehículo es de "; 

            if (limitarA120 && kmHora > 120)
            {
                textoDeSalida = "La velocidad del vehículo era de " + kmHora + " Km/h, pero ahora es de ";
                kmHora = 120;
            }
            return  textoDeSalida + kmHora.ToString() + " km/h";
        }
    }
}

VB.NET

/* ************************************************
* © WAKI 2014
* PROYECTO:        Aprender a Programar.
* Archivo:         Program.cs
* Descripción:     Clase Main y Vehículo
* Historial:
* Comentarios:
*
****************************************************/
using System;
namespace MyNameSpace
{
    class MyApp
    {
        static void Main(string[] args)
        {
            Console.WriteLine ("Comienza la App");
            Vehiculo miVehiculo = new Vehiculo();
            string textoDeSalida = miVehiculo.Avanzar(90); // esto hace avanzar el vehículo hasta los 90km/h. 90 es el ARGUMENTO
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine ("Pulse una tecla para frenar el vehículo...");
            Console.ReadLine();

            textoDeSalida = miVehiculo.Avanzar(0); // esto hace parar. 0 es el ARGUMENTO
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine("Pulse una tecla para activar velocidad predeterminada...");
            Console.ReadLine();

            textoDeSalida = miVehiculo.Avanzar(); // esto hace parar. 0 es el ARGUMENTO
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine("Pulse una tecla para limitar velocidad...");
            Console.ReadLine();

            textoDeSalida = miVehiculo.Avanzar(150,true); // velocidad a 150 km/h y limitador activado
            Console.WriteLine(textoDeSalida);   // Aquí se imprime el texto devuelto por los métodos
            Console.WriteLine("Pulse INTRO para finalizar..");
            Console.ReadLine();
        }
    }

    class Vehiculo
    {
        public Vehiculo()
        {
            // código utilizado al instanciar la clase
        }

        public string Avanzar(int kmHora)
        {
            // kmHora es el parámetro tipo número entero del método Avanzar
            return "La velocidad del vehículo es de " + kmHora.ToString() + " km/h";
        }

        public string Avanzar()
        {
            // avanza hasta los 50 Km/h como valor predeterminado
            return "La velocidad del vehículo es de 50 km/h";
        } 

        public string Avanzar(int kmHora, bool limitarA120)
        {
            // kmHora es el parámetro tipo número entero del método Avanzar
            // limitarA120 no permite que pase de 120 km/h
            string textoDeSalida = "La velocidad del vehículo es de ";
            if (limitarA120 && kmHora > 120)
            {
                textoDeSalida = "La velocidad del vehículo era de " + kmHora + " Km/h, pero ahora es de ";
                kmHora = 120;
            }
            return  textoDeSalida + kmHora.ToString() + " km/h";
        }
    }
}

Analizando código… en el método Main, ocurre lo siguiente:

  1. Escribimos en la consola “Comienza App ==>”
  2. Creamos el objeto miVehiculo
  3. Llamamos al método Avanzar(90) de miVehículo pasando el argumento 90
  4. Se visualiza en la consola “La velocidad del vehículo es de 90 Km/h”
  5. Escribimos en la consola “Pulse una tecla para frenar el vehículo…”
  6. Al pulsar INTRO, llamamos de nuevo al método Avanzar(0) de miVehículo pasando el argumento 0
  7. Se visualiza en la consola “La velocidad del vehículo es de 0 Km/h”
  8. Escribimos en la consola “Pulse una tecla para activar velocidad predeterminada…”
  9. Al pulsar INTRO, llamamos de nuevo al método Avanzar() sin argumentos de miVehiculo.
  10. Se visualiza en la consola “La velocidad del vehículo es de 50 Km/h”
  11. Escribimos en la consola “Pulse una tecla para limitar velocidad…”
  12. Al pulsar INTRO, llamamos de nuevo al método Avanzar(150) de miVehículo pasando el argumento 150
  13. Se visualiza en la consola “La velocidad del vehículo era de 150 Km/h, pero ahora es de 120 Km/h.”
  14. Al pulsar INTRO finalizamos.

En el último método Avanzar creamos una variable textoDeSalida, a la cual le damos un valor u otro dependiendo si se limita la velocidad o no y para devolver los valores al lugar desde los hemos llamado es mediante la instrucción return que retorna o devuelve el valor calculado.

Para la sobrecarga de métodos, lo único que no podemos hacer es crear dos métodos con el mismo número de parámetros y del mismo tipo, lo que provocaría una ambigüedad y el compilador no sabría cual ejecutar.

Como ya sabemos compilar, practica y crea, que no duele!

Saludos “der Waki”

7.- Un modo de tener el código ordenado

7.- Un modo de tener el código ordenado
Como ya dije en el Post 5, el coste llevado a cabo para el mantenimiento del software es muy costoso, por lo que sería muy conveniente escribir un código muy comentado, claro y estructurado, esto nos daría limpieza y efectividad pudiendo detectar y minimizar los ERRORES (porque haberlos, «haylos»)
Para comentar el código, escribimos en C#
// Aquí van los comentarios
o en VB.NET
’Aquí van los comentarios.
Este texto en Visual Studio se torna verde cuando se trata de un comentario.
Si en vez de dos barras, escribimos tres, podemos escribir comentarios continuamente al pulsar ENTER y cambiar de línea, escribiéndose automáticamente otras tres barras (C#) o comillas simples(»’).
Si estamos programando en Visual Studio y escribimos estas tres barras o comillas simples encima de un método, variable, propiedad, etc., es decir sobre un miembro de clase, se inserta automáticamente una etiqueta llamada <summary> con otra etiqueta de cierre </summary> y el contenido que escribamos entre estas dos etiquetas se visualizará automáticamente con IntelliSense
que es una herramienta de ayuda de Visual Studio con la cual según vamos escribiendo, se van visualizando los miembros de clase disponibles en esta;
además visualiza la información escrita entre las dos etiquetas <summary>Esto describe el miembro de clase </summary>.
Una vez comentado el código, existe otra forma de tener el código ordenado mediante bloques y esto se hace escribiendo
C#

#region MyRegion

// aquí podemos poner todos los

// miembros de clase que queramos
#endregion

VB.NET

#Region "MyRegion"
        ' aquí podemos poner todos los
        ' miembros de clase que queramos
#End Region

Esto no se compila y simplemente nos permite mantener los miembros de clase ordenaditos y enclaustrados entre regiones o bloques de código, por ejemplo, podemos crear una región llamada propiedades y variables donde incluyamos solo exclusivamente estos miembros u otra donde incluya los métodos asociados a controles y dentro de esta más bloques de código separándolos por tipo de control, de modo que cuando quiera visualizar un método asociado a un evento click de un botón, me iré a la región Controles y dentro de esta a otra región llamada Botones y en su interior estará el método que busco evitando dar muchas vueltas con la rueda del ratón o efectuando búsquedas de texto.Debemos pensar que el código será revisado por otra persona o por nosotros mismos miles de años después, por tanto, ordena!!! (¿miles? jajajaja dejémoslo en cientos).
Además, imaginemos una clase con 1000 líneas, al incluir el código entre regiones, es posible contraer o expandir las regiones, evitando mantener las mil líneas desplegadas con el consiguiente lio.
Otra forma de de mantener claro el código es escribir con mucha sencillez los métodos, espaciados y con pocas líneas (A ser posible).
Otro aspecto muy importante es la nomenclatura de los nombres de las clases y miembros de clase, ¿por qué es importante? Pues si recuerdan cuando en el lenguaje “der waki” asignábamos los nombres a las características y métodos de la clase vehículo, los nombrábamos con Velocidad, Potencia, Matrícula, Número de Bastidor, Arrancar, Parar, Avanzar, etc., pues eso, cuando quiero asignarle la matrícula a la propiedad Matrícula debo hacerlo con sentido común; si le hubiéramos puesto como nombre Abrigo, diría ¿para qué le he puesto el nombre Abrigo a la propiedad Matrícula?
Menuda tontería no!! Pues por ahí van los tiros.

Existen múltiples notaciones para nombrar los miembros de clase, pero nos centramos en dos, notación Pascal y Camello ( que nombres!!). La notación Pascal utiliza la primera letra de cada palabra con mayúscula, de modo que si nombramos la propiedad NumeroBastidor, iniciamos cada palabra con mayúsculas sin espacios y si usamos la notación camello es igual que la Pascal pero iniciando con minúsculas y dándole ese aspecto de jorobas de camello subiendo y bajando.
Microsoft utiliza este método para crear sus aplicaciones y dependiendo del miembro
de clase que sea, adaptaremos el nombre de un modo u otro y que a continuación detallo:

  • Espacios de nombres. Para los espacios de nombres se usa el nombre de la compañía o el nombre del producto con la primera letra en mayúscula y resto en minúsculas, por ejemplo Microsoft tiene un espacio de nombres Microsoft de alto nivel y según van creando productos, le agregan un nuevo espacio de nombres,  Microsoft.Win32,  System.Windows.Forms, etc.
  • Para las clases, utilizamos sustantivos con notación Pascal. Otra manía que tengo y que aprendí de dos buenos programadores, es encabezar las clases con comentarios, nombre del archivo de la clase, que hace la clase, quien la ha creado y cuando, si le introduzco modificaciones, que modificaciones se han realizado y cuando, en definitiva, una serie de datos que me informen de la clase.
  • Para los métodos también Notación Pascal, pero como los métodos hacen cosas, actúan, llevan a cabo una labor, interesa que describan los que hacen mediante verbos acompañados de objeto sobre el que recae la acción. Por ejemplo ImprimirFactura, CalcularSalario, AbrirBaseDeDatos, ObtenerUsuario, etc. Yo personalmente, uso en castellano los métodos privados y los métodos públicos los pongo en inglés para globalizar la clase, si estos métodos los hiciera públicos, les daría PrintInvoice, CalculatePay,OpenDataBase, GetUser, etc. Debo hacer hincapié en que existen métodos que además de hacer algo obtienen algo, como el último ejemplo ObtenerUsuario que se encargaría de buscar en algún sitio el usuario que está activo en el momento, bueno pues existen métodos que comprueban algo por ejemplo EstaLaPuertaAbierta
    y si lo está, devolvería un valor verdadero y si no lo está devolvería un valor
    falso, este tipo se llaman boolean de Boole el matemático que estudio el algebra de su mismo nombre sobre el sistema binario, pues este tipo de métodos deben comenzar con la tercera persona del verbo ser o estar, en inglés Is, por ejemplo IsOpenDoor, de modo que si utilizamos este método con alguna condición, sería mucho más claro de entender, en el lenguaje “der Waki”

Si está abierta la puerta, ciérrala

En C#

if (IsOpenDoor())
{
     // cerrar puerta
}

En VB.NET

If IsOpenDoor() Then
     ' cerrar puerta
End If
  • Las propiedades. Estilo Pascal (primera en mayúscula de cada palabra)
  • Variables. Sobre las variables o campos, hay tema para todos los gustos. Vamos a ver, si una clase se llama Autor y creamos un campo que identifique al autor, no vamos a ponerle el mismo nombre de la clase, le ponemos por ejemplo NombreAutor con notación Pascal y cuando accedamos a esta variable los haremos mediante Autor.NombreAutor. Para las variables privadas o de menor entidad, yo utilizo la notación Camello (primera en minúsculas) y en algunos casos (para gustos los colores) le incluyo a la notación camello un guión bajo al inicio, así de un primer vistazo introduciendo un guión, echo un vistazo sobre estas.

De todos modos, los IDE (Entornos de Desarrollo Integrado) como Visual Studio, Eclipse, etc.., cambian de color (como los comentarios que los ponía en verde) cada elemento dependiendo del tipo que sea.

En resumen, para todo programador es importantísimo el orden, tengo la experiencia de crear aplicaciones con pocas líneas de código y que al volver a modificar algún detalle, volverse en un trabajo tedioso, por tanto el tiempo invertido inicialmente es fundamental para futuras modificaciones o ampliaciones.

Saludos «der Waki»