¿Cómo crear buenos comentarios en tu código?

 Al programar y escribir código, debemos recordar que antes que todo estamos escribiendo en un lenguaje de programación para facilitar la lectura a otros humanos. Si bien la sintaxis de un lenguaje puede ser muy amigable por si sola, una buena práctica es agregar comentarios que puedan aportar más al entendimiento del problema que se resuelve. 

A medida de que los programas que escribimos se vuelven más grandes, agregar comentarios puede resultar de gran ayuda a los programadores que se acercan por primera vez a esta base de código, pero es necesario tomar en cuenta algunas recomendaciones para limitar su función como una ayuda en casos donde consideremos que sea necesario y evitar llenar el código con comentarios para cada comportamiento reflejando un severo caso de comentaritis aguda.

 

Agrega comentarios sólo cuando sea necesario

Siempre debemos tomar en cuenta que el código debería hablar por si mismo, por ejemplo, no deberías agregar un comentario para indicar el contexto de una variable o de una función. En medida de los posible, los comentarios deben evitar ser innecesarios como por ejemplo explicar un comportamiento que dentro del contexto resulta obvio.

Agregando buenos comentarios

Para que tus comentarios sean efectivos, debes escribirlos de manera que puedan ser entendibles por cualquier persona. Un buen comentario debería responder a la pregunta ¿porqué? en lugar de responder a la pregunta ¿qué?. También es importante mantenerlos actualizados, puesto que al modificar una rutina o variable y no actualizar el comentario asociado podríamos caer en una contradicción que volvería confuso a tu código.

Comentar tu código siempre es una buena práctica para agregar legibilidad y hacer más entendible lo que estás tratando de resolver. Existe una línea que separa el código sobre-comentado del código poco-comentado. A medida que se vaya adquiriendo experiencia escribiendo más programas, se aprende a conocer cuándo resulta efectivo y cuándo no el agregar comentarios.

Referencias:

PEP 8 — the Style Guide for Python Code - Comments

Comenzando con AJAX parte 1: El objeto XMLHTTP Request

AJAX es el acrónimo de Asynchronous JavaScript and XML, actualmente este último término no hace mucho sentido para un desarrollador moderno porque básicamente XML ya no es tan popular como lo es JSON. No es un framework, mucho menos una librería. AJAX es una técnica utilizada para desarrollar aplicaciones interactivas utilizando tecnologías y herramientas ya existentes como JavaScript.

La apropiación del término se le atribuye a Jesse James Garrett quien publicó una entrada en su blog titulada “Ajax: A New Approach to Web Applications”. En ella detalla esta nueva técnica que permite actualizar una página web enviando y recibiendo datos desde un servidor sin necesidad de refrescar totalmente la página completa, todo esto en segundo plano.

fuente: https://en.wikipedia.org/wiki/Ajax_(programming)

AJAX con el objeto XMLHTTP Request

El objeto XMLHTTP Request, es la forma original de hacer requests desde el navegador. Creado por Microsoft e implementado en Internet Explorer 5.0 como un objeto ActiveX, que implicaba ser utilizado en cualquier entorno de desarrollo de software compatible con esta tecnología, no fue sino hasta el 2006 que fue implementada en Internet Explorer 7 y se comenzó a crear el primer draft para estandarizarlo en la W3C.

Ejemplo básico de una petición XMLHTTP Request a una API

Linea 1: se crea una instancia del objeto.

Lineas 3 – 7: el método onreadystatechange se ejecuta cada que se registra uno de los estados del cliente XHR, el método readyState change registra los 4 estados del cliente siendo 4 el estado correspondiente a done, cuando los datos han sido recuperados. XHR.status indica el código de status http, validamos que sea un HTTP 200 OK. En responseText se obtienen los datos recuperados de la API por el request.

Linea 9: Se crea la conexión especificando como parámetros el método (en este caso GET) y la url.

Aprendiendo a Programar desde 0

Desde hace aproximadamente 2 años, la cantidad de ofertas para aprender a programar se ha incrementado considerablemente. Básicamente, gracias a la proliferación de historias maravillosas sobre el éxito de jóvenes emprendedores programadores que se hicieron ricos de la noche a la mañana, o por el impulso de la necesidad de adquirir alguna habilidad que te pueda asegurar un trabajo en la creciente industria del desarrollo de software.
Sea cual sea el motivo que los lleve a aprender a programar, hay una serie de constantes que hay tomar en cuenta a la hora de iniciar. Esto es mi experiencia personal y no es un manual o una receta que se deba seguir religiosamente al pie de la letra, así que aquí van:

Aprenda un lenguaje y apréndalo bien.

¿Porqué digo esto? porque el mundo del desarrollo de software, principalmente del desarrollo web, es cambiante y tendencias van y vienen. Podrás empezar a programar en python y alguien te dirá que javascript es más cool y con NodeJS podrás hacer cosas interesantes, tanto frontend como backend, pero sinceramente creo que las tendencias sólo quedarán en una forma diferente de hacer las cosas y sea cual sea el lenguaje que elijas dependerá mucho de lo que quieras hacer con él. Personalmente yo elegí python por la extensa documentación que he encontrado en linea, la facilidad con la que se puede instalar un entorno para practicar tanto en Windows como en Linux y que puedo utilizarlo tanto como para web por medio de un framework como Django y para muchos otros usos fuera de web.

De ser posible, instala un linux en tu computadora.

No es sopresa para nadie que inicia en el desarrollo de software que la mayoría de los servers de los servicios populares que encontramos en internet corren algún sistema compatible con UNIX. Cuenta con una inmensa cantidad de recursos para ayudarte en tu camino para programar y te puede ayudar a comprender un par de cosas sobre como funciona un sistema operativo si es que optas por elegir una distribución que exija un esfuerzo extra por parte del usuario para dejar tu sistema a tu gusto (como arch o gentoo). Si es la primera vez que usas una distribución de linux te conviene elegir ubuntu.

Aprende a utilizar un software de Virtualización.

En este caso, recomiendo usar Virtualbox principalmente por ser gratuito. Al virtualizar un servidor en tu computadora, no te meterás con los archivos de tu sistema ni tendrás que instalar servicios que estén abriendo puertos en tu sistema operativo. Además de que si hechas algo a perder, podrás recuperar tu sistema en un par de clicks o borrar completamente tu máquina virtualizada y empezar de cero. Existen soluciones para montar este tipo de sistemas de manera muy sencilla con software como Vagrant y Puppet, pero al principio recomiendo hacer todo esto desde cero para irse familiarizando con el proceso, posteriormente opta por automatizarlo con este tipo de aplicaciones.

Pon en práctica lo aprendido.

No hay de otra. No existe una fórmula mágica para aprender a programar y terminar "n" cantidad de tutoriales o cursos en linea no te asegura que lo aprenderás. Hechando a perder se aprende. Tus primeros programas, aplicaciones y sitios web estarán llenos de errores, esto es seguro, pero poco a poco a base de mucha prática tus habilidades mejorarán.

El cuarto integrante en la portada de Bleach

Sub Pop fué el mítico sello discográfico subterráneo que grabó por primera vez la escena de Seattle, Washington y alrededores de finales de la década de los 80´s. Lo que después las grandes discográficas tomarían y lo etiquetaran para su venta al público consumidor como "grunge". El trabajo de la disquera, y la determinación de sus propietarios Jonathan Poneman y Bruce Pavitt los llevó a ser los primeros en poner la mira en bandas como Nirvana, Soundgarden y Mother Love Bone y Green River, donde las dos últimas bandas formarían al final lo que ahora conocemos como Pearl Jam.

El primer acercamiento Nirvana con el sello discográfico resultó en el sencillo Love Buzz/Big Cheese, en ese entonces los discos de Sub Pop eran distribuidos por medio de una subscripción, de este disco sólo hubo 1000 copias y actualmente es el más buscado por los fans de la banda. Después del lanzamiento del single y algunos LP de los demás compañeros de sello, como Soundgarden, Nirvana intenta dar el primer salto en busca del LP. Esta oportunidad se da gracias a la aparición de Jason Everman, de oficio pescador en su natal Alaska. Regresaba de una buena temporada de pesca con algo de dinero. También músico, guitarrista, que posteriormente se incorporaria a Soundgarden, supo de Nirvana gracias a un demo que le facilitó su amigo Dale Crover, baterista de Nirvana. Fascinado por la cinta, Kurt logró convencerlo de que le prestara dinero que costeara el estudio de grabación y lanzar la primera placa con Sub Pop. El lugar: Reciprocal Recording Studio, un antro-estudio de grabación muy popular por su propietario e ingeniero principal: Jack Endino, guitarrista de Skin Yard, banda veterana de Seattle.

La cifra pactada fueron exactamente 606.17 dólares por 30 horas de grabación en una consola de 8 canales, entre diciembre de 1988 y enero de 1989, la distribución corrió a cargo de Sub Pop y en agradecimiento a Jason Everman por poner el dinero para la grabación, Nirvana lo incluyó en los créditos del disco como segunda guitarra, aunque en realidad no grabó en un sólo track. El lanzamiento del disco fué en Junio de 1989.

La portada del disco es una fotografía obra de Tracy Marander, novia de Kurt Cobain en ese entonces, que lo inspiró a escribir "About a Girl". La fotografia en blanco y negro fué tomada durante una presentación en la galeria Reko Muse en Olympia, Washington. En ella inmortalizaría la figura de Jason Everman con su Fender Telecaster como el primer cuarto integrante de Nirvana.

Amen Break

En 18:08 minutos, Nate Harrison explica la importancia y la influencia de este sample extraido de “Amen, Brother” un tema de The Winstons del año 1969.

Usado en sus inicios en el hip-hop de los y abusado a lo largo de los 90´s, era escuchado en casi cada tema de breakcore, drum and bass y jungle. Todos los nacidos de finales de la decáda de 1970 y mediados de los 80´s lo hemos escuchado al menos una vez.

Jamaica Sonora

Jamaica Sonora

Las diferentes manifestaciones musicales que surgieron en esta de isla de las Antillas Mayores a mediados del siglo pasado, dejaron una estela tan visible que aún es notoria en la música del siglo XXI.

Soundsystems.

En 1954, Coxsone Dodd, cuyos padres eran propietarios de una tienda de discos en Jamaica, regresaba de Estados Unidos con algunos discos, equipo y amplificadores para iniciar la promoción de la tienda de sus padres tocando los discos en público, lo que le valió ser popularizado por ser el responsable de bailes improvisados frente a su establecimiento. La respuesta del público fué positiva y Dodd iniciaba popularizando el concepto del “Soundsystem”, colaborando junto a dos personajes que se volvieron clave en la consolidación de la cultura del sonidero: U- Roy y Lee Perry. Como encargados de escojer los discos que amenizarían el baile eran llamados “selecters”. Roy, además de amenizar las fiestas con su selección musical, improvisaba frases sobre las pistas que sonaban en las bocinas, así nació el “toasting”.

Probado el extraordinario éxito del Soundsystem, Duke Reid “The Trojan” inició la competencia directa para Dodd con el “Treasure Island Sounsystem”, con ellos iniciaron las batallas entre sonideros donde el mejor disco o canción tocada decidida por el público daba la victoria. En estos concursos públicos, los Selecters utillizaban la técnica del “Scratching”, deslizando su mano sobre el disco girando en la tornamesa, para lograr que lo que comunmente era escuchado por el público llegara a ser de una manera diferente. El trabajo de estos pioneros y sus técnicas, son ahora perfeccionadas y puestas en práctica por sus herederos directos, los DJ´s y los MC´s.

Escucha Recomendada: La recopilación de la disquera Trojan: Dj Box Set

Ska.

Cecil Campbell, mejor conocido como “Prince Buster”, fué contratado como guardia de seguridad por Coxsone Dodd para las fiestas que organizaba el Soundsystem, su acercamiento con la música lo llevó a buscar un nuevo estilo para dejar atrás los ya tan gastados ritmos de blues y rythmn and blues que estaba de moda en la isla. De la mano del guitarrista Jah Jerry, crean el nuevo sonido característico del rasgueo ska, acentuando el “offbeat”, es decir, no el golpe rítmico, sino después de éste.
El naciente Ska, fué llamada la música nacional de Jamaica, los Soundsystems comenzaron a grabar discos de Ska, se producían ellos mismos y empezaban una industria artística y ecónomica prolifera que fue motivo de pequeñas riñas entre ellos. Surgieron los “Dancehall Crashers”, que no eran más que saboteadores enviados por la competencia para terminar con los bailes de los sonideros contrarios.

Para principios de los 60´s, el optimismo derivado de la independencia de la isla no llegaba a todos los sectores: jóvenes habitantes de los ghettos se mantenían con problemas por la falta de empleo y su consecuente inestabilidad ecónomica. La clase obrera jamaiquina manifestada en la juventud encontró su identidad en el “RudeBoy” tratando de ser alguien en una sociedad que los destinaba a la marginación. El RudeBoy bailaba Ska, de una manera más lenta e imponente que los demás, se vestía al estilo gangster y compartían similitud en la indumentaria con el Pachuco Mexicano. El RudeBoy escuchaba Ska y vivia al margen de la ley, Jimmy Cliff lo inmortalizó en el filme “The harder they come” dirigida por Perry Hanzel.
Bandas como Los Heptones y Los Skatalites tomaron la escena, de este periodo es el nacimiento de Los Wailers: Bob Marley, Peter Tosh y Bunny Wailer; un trio de Rude Boys apoyados por Coxsone Dodd quienes se hace acreedores de una pequeña fama que no logra salir de la isla, aún.

Escucha Recomendada: Foundation Ska – The Skatalites