mayo 16, 2009

Code Conventions for the JavaTM Programming Language

hao,

El cholo (amigo de la u) me escribe: "Cholo una pregunta, un lugar donde den tips para programar... Por ejemplo, lo de comentar código. Identificar variables con respecto a su función... cosas así... No tienes un post por ahí a la mano?¡¡?"

Le respondo al cholo: "Uyy cholo me puso a revolcar el historial jeje... yo se que había visto un doc. que contiene unas las convenciones y estándares para programar, de la A a la Z, las mejores practicas al momento de tirar código xD, por supuesto de java, pero aplicable a cualquier otro lenguaje; después de 1 hora de exhaustiva búsqueda me di cuenta de 2 cosas:
  1. Para buscar cosas en el historial con chrome uno se muere de hambre, debería tener una búsqueda avanzada, que filtre por fecha como mínimo. O es que no lo supe utilizar :S
  2. Cuando uno se topa con información importante, que no puede o no quiere leer en ese momento, pero sabe que le va a ser de utilidad, nada mejor que hacerle referencia en algún sitio especifico en donde tenemos cosas interesantes pendientes por revisar.
En fin, "ak ta": Code Conventions for the JavaTM Programming Language

Con esta corto doc. nos trasladamos en el tiempo, en los primeros años de la escuela, cuando la profesora nos decía:
  • 5 pts. menos por no dejar sangría al inicio del párrafo.
  • 5 pts. menos por no colocar mayúscula después del punto.
  • 5 pts. menos por ... eso, eso mismo que recuerdas, xD
Jejeje ya veras..."

Y así fue..., y ahora os comparto esta Rueda.

Este documento contiene las convenciones y estándares que Sun sigue y recomienda que nosotros sigamos. Cubre: los nombres de archivo, organización de los archivos, comentarios, declaraciones, sentencias, espacios en blanco, convenciones de nomenclatura, prácticas de programación e incluye código de ejemplo.

¿Por qué las convenciones de código?
  • El 80% del costo de una pieza de software se destina a mantenimiento. (No creas que todo quedo perfecto a la primera).
  • La mayor parte del software es mantenido, durante toda su vida, por el autor original. (O vas a dejar que otro haga fiesta con tu creación xD).
  • Las convenciones de código ayudan a mejorar la legibilidad de los programas informáticos, lo que permite a los ingenieros comprender el código más rápido y en profundidad. (A menos que tengamos una maquina virtual instalada en nuestro cerebro lista para compilar código ofuscado juju).
  • Si su código fuente es un producto (lo vas a vender o compartir), es necesario asegurarse de que este claro y limpio, como cualquier otro producto que usted desearía.
Este doc. es perfecto para perfeccionar el "estilacho" cuando "tiramos código", pero si algunos de nosotros tiene un pana que se inspira "tirando código ofuscado", como toño y adrián (amigos de la u), nos taca recomendarle el libro completo The Java Language Specification, jeje hechando broma.

El doc. anterior se queda pendejo al lado del libro, dice: If you want to know the precise meaning of the language's constructs, this is the source for you. Uff quien dijo miedo. Bueno muchachos que disfrutenlo.

Que la fuerza este contigo! ;)

1 comentario:

Unknown dijo...

yo he visto el trabajo de Adrián y no es ofuscado como el de toñito :o es de nivel todos deben aprender de él

Creative Commons License