¿Cómo comentar nuestro código?

 

/* ******************************************************

Este post trata de un tema muy importante que muchas veces pasamos por alto los programadores, el poner comentarios a nuestro código. Ya sea para nosotros o para otro que le toque la tarea de mantener nuestros programas, es de suma importancia y ayuda el agregar los comentarios lo suficientemente explicativos para entender lo que hace un método en particular, mmmm….No, ya en serio esto se trata de los mejores comentarios con los que me he topado el día de hoy domingo, la lista original y completa la pueden encontrar en StackOverflow.com , un ejemplo:

//
// Dear maintainer:
//
// Once you are done trying to ‘optimize’ this routine,
// and have realized what a terrible mistake that was,
// please increment the following counter as a warning
// to the next guy:
//
// total_hours_wasted_here = 16
//

Traducción😎

//
// Estimado desafortunado:
//
// Una vez que hayas terminado de intentar optimizar esta rutina,
// y te hayas dado cuenta el terrible error que fue,
// por favor incrementa el siguiente contador como advertencia
// para el siguiente tipo:
//
// total_horas_desperdiciadas_aquí = 16
//

NOTA: Todos los comentarios citados aquí son propiedad de sus respectivos programadores.

****************************************************** */

// TODO: Ingrese su comentario luego de esta línea.

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: