Programar en Mac 02: Los comentarios

Programar en Mac 02: Los comentarios

26 abril, 2010 |  by  |  Programar en Mac

Vamos con el capítulo 02 de Programar en Mac. Cómo sabéis estamos haciendo un repaso a C al mismo tiempo que hacemos los PDF orientados exclusivamente a Cocoa.

Comentarios…

Con el uso de nombres sensibles de variables (que vimos en el capítulo anterior), podemos hacer nuestro código más inteligible y entendible [1].

// [1]
float pictureWidth, pictureHeight, pictureSurfaceArea;
pictureWidth = 8.0;
pictureHeight = 4.5;
pictureSurfaceArea = pictureWidth * pictureHeight;

Nuestro código sólo contiene por ahora unas pocas líneas de código pero los programas más sencillos fácilmente pueden alcanzar cientos o miles de líneas de código. Cuando vuelves a revisar el código  después de algunas semanas o meses puede ser complicado recordar la razón por la que programar cada cosa. Esta es la razón por la que aparecen los comentarios.

Los comentarios te ayudarán a entender rápidamente la razón de ser de una determinada parte de tu código y por qué está en cada lugar. Algunos programadores suelen ir más allá y comienzan cada código con un comentario que les ayuden a organizar su pensamiento y les permitan codificar personalmente desde un rincón.

Te recomendamos que dediques un tiempo a comentar tu código. Te aseguramos que así compensarás en el futuro el tiempo que gastes hoy con los comentarios. Además, si compartes tu código con alguien más, tus comentarios podrán ayudarles a adaptar lo que necesiten con mayor velocidad.

Crear un comentario

Para crear un comentario, comienza el comentario con dos barras inclinadas.

// Esto es un comentario

En Xcode los comentarios se muestran en verde. Si un comentario es muy largo y requiere múltiples líneas, deberás escribirlas entre /* y */.

/* Esto es un comentario
que se extiende a dos líneas /*

Outcommenting

Pronto trataremos cómo resolver los bugs de un programa y las grandes facilidades que Xcode da para ello. Una manera de resolver los bugs, el método pasado de moda, es el llamado outcommenting. Colocando parte de tu código entre /* y */ podemos temporalmente deshabilitar esa parte del texto (algo así como convertir en comentario lo que era código) para ver si el resto del código funciona como esperamos. Esto nos permite dar caza al bug. Si la parte convertida en comentario es, por ejemplo, un valor de una determinada variable, podrás incluir una líea temporalmente donde estaba la variable o un valor que encaje para probar el resultado de tu código.

¿Por qué comentarios?

La importancia de los comentarios no puede ser exagerada. Se usa normalmente para añadir una explicación en lenguaje asequible sobre lo que va en una serie de líneasde código. Esto es porque no tienes porque deducir qué es cada código y puedes ver inmediatamente si el problema que estás experimentando está en esa parte del código. También puedes utilizar códigos para expresar cosas que son complicadas o imposibles de deducir del propio código. Por ejemplo, si programas una función matemática usando un modelo específico descrito con detalle en alguna parte de un libro, podrás poner la referencia bibliográfica en un comentario asociado al código del que hablamos.

Algunas veces es útil escribir varios comentarios antes de escribir el código de programación. Esto puede ayudarte a estructurar tus pensamientos y el resultado de la programación será más sencillo.

Los ejemplos de código en este manual no contienen tantos comentarios como nos gustaría normalmente al escribir un código, porque están acompañados todos ellos de los textos de explicación.

 

8 Comments


  1. Muchas gracias por el artículo. Estoy siguiendo vuestro tutorial y me encanta. Así aprende a programar cualquiera ;)

  2. ¿Voy a hacer una pregunta al aire…en que idioma escribir los comentarios?

    • Los comentarios se pueden escribir en el idioma que quieras (como si no pones comentarios)…

      Simplemente son una manera de hacer anotaciones para luego acordarte de cosas o facilitar la lectura, por ejemplo

      */ Esta función realiza el calculo de ángulos de un polígono a partir de su número de lados, el argumento es el número de lados y devuelve el ángulo en radianes, en un valor tipo float/*

      A la hora de compilar el código se saltará esas líneas para que el programa funcione pero tú las leerás y entenderás mucho mejor la función que
      (float)calcAngPol(int lados);

      • Sinceramente lo puse como pregunta con trampa, dejando de lado de que pienso que el código debería ser mayormente autocomentado. Poner variables/comentarios en otro idioma que no sea en inglés lo veo estupido por 3 razones.

        1. Las librerías base ya están en inglés, ¿porque le vas a meter otro idioma de por medio?

        2. En un proyecto en el que trabajen desarrolladores alemanes ingleses españoles etc. Si cada uno pusiera los comentarios en su idioma el resulto sería un proyecto en el que necesitas dominar 5 idiomas para entenderlo.

        3. Si los comentarios facilitan la lectura, deberían ser leibles por todo el mundo o al menos la mayor cantidad de gente posible y eso por ahora solo es posible haciendolo en inglés.

        Un ejemplo de lo que me refiero.

        http://pastebin.com/rTAjxU9F

        • Yo creo que deberían estar en el idioma al que va dirigido el proyecto o las personas que lo puedan leer.
          Si el código es propio por qué poner las variables y comentarios en Inglés??

          En definitiva, variables y comentarios como te dé la gana, como sea más fácil para ti y las apersonas que trabajan contigo.

          La imagen que pones es un proyecto en Alemán, las palabras claves están en inglés porque los estadounidenses fueron los que crearon la mayoría de lenguajes de programación. Supongo que un Alemán no tendría problemas con ese código.

  3. Muy buenas, se que es algo que en cuanto me ponga con xCode veré enseguida, y aunque es una “chorrada” puede confundir a alguien.

    Los comentarios largos tal como los describes en el texto son igual que en PHP es decir /* */ pero en el código es así /* /* .

    Cual es el correcto?
    Supongo que ya de paso os ayuda a hacer esta pequeña corrección :)

    PD: Llevo tiempo intentando introducirme en xcode hace tiempo es a sido este gran tutorial que estáis haciendo el que al final me ha quitado el miedo.

    Felicidades!

  4. Cuando estudiaba aprendi a programar en c, pascal, cobol y un monton de esos lenguajes pero con el tiempo me dedique a VB.net por que en mi trabajo no tenia tiempo para estudiar algo mas o ahondarme en nuevas plataformas, ahora que ya tengo handado mi sistema y gracias a wine lo tengo corriendo en mac y linux puedo darme el lujo de empezar con otro lenguaje ya que decidi que ciertas personas de mi empresa compraran mac, tengo un sistema en iphone a traves de .net pero quiero hacer algo nativo y encuentro esta pagina una excelente ayuda para iniciarme en este mundo.

    Gracias por el tiempo que se han tomado

Trackbacks

  1. Programar en Mac 02: Los comentarios | AppleNeXt

Leave a Reply