LinuxParty

Los programadores tienen su animal doméstico "peeves". Ya sea en el ámbito de aplicación, en la notación húngara, en el mal olor, o en sus compañeros de trabajo, hemos llegado a aceptar que hay ciertas molestias que vienen con nuestra línea de trabajo. La siguiente es una lista de las 10 principales cosas que más molestan a los programadores, compilado a partir de los resultados de mi reciente pregunta sobre StackOverflow (usted debe ser un beta tester para acceder a este vínculo), junto con algunos de mis propias experiencias como programador: 10. Comentarios que explican el "cómo" pero no el "por qué"

Introductorias, la programación a nivel de cursos sobre como enseñar a los estudiantes en sus principios a poner comentarios y observaciones. La idea es que es mejor tener demasiados comentarios que tener muy pocos. Por desgracia, muchos programadores parecen tomar esto como un reto personal para comentar cada línea de código. Esta es la razón por la cual a menudo ver algo como este código snippit tomado de Jeff Atwood's Coding puesto en "Sin Comentarios"


¿Tiene alguna idea de lo que hace este código? Yo tampoco. El problema es que, si bien hay un montón de comentarios que describen lo que el código está haciendo, no hay ninguno que describe la razón por la que está haciendo.

Ahora bien, considerar el mismo código con una metodología diferente de comentarios:

// square root of n with Newton-Raphson approximation
r = n / 2;

while ( abs( r - (n/r) ) > t ) {
r = 0.5 * ( r + (n/r) );
}

Mucho mejor! Todavía no podía entender exactamente lo que está pasando aquí, pero al menos tenemos un punto de partida.

Los comentarios son supuestamente para ayudar al lector a comprender el código, no la sintaxis. Es un justo supuesto de que el lector tiene una comprensión básica de cómo un bucle de obras; no hay necesidad de añadir comentarios como: "/ / iterar sobre una lista de clientes". Lo que el lector no va a estar familiarizados con razón, el código que funciona y por qué elegiste a escribir de la misma manera que lo hizo.

9. Interrupciones

Muy pocos programadores pueden partir de 0 cuando le dan un código. Tendemos generalmente a ser más relacionados con las locomotoras que ferraris; puede tomarnos un rato para conseguir comenzar, pero una vez que lo hacemos, nuestro paso grande, nosotros podemos conseguir una cantidad de trabajo impresionante hecha. Desafortunadamente, es muy duro conseguir en una zona programada cuando su tren del pensamiento está siendo descarilado constantemente por los clientes, los encargados, jefes, y los compañeros programadores .

El resto del artículo, el traducción automática, aquí. (yahoo)
Traducción automática, aquí. (google)
El artículo original en Inglés, aquí.