Guias de estilo: respeta la indentación original

Después de los dos artículos reflexionando sobre la indentación y sobre si los espacios son mejor que los tabs a la hora de indentar, creo que no sería justo terminar esta discusión sin comentar que sea cual sea tu convención particular, respetes la de los demás.

Con respetar la indentación de los demás no me refiero a que respetes sus ideales  de indentación (que también), me refiero a que si por lo que sea, cae en tus manos código de terceros y tienes que actualizarlo, debes mirar como está indentado y respetar esa indentación en el nuevo código que escribas o modifiques.

Por ejemplo, enviar un parche a un proyecto open source es un caso evidente y casi común (sobretodo con los miles y miles de proyectos open source que hay en el mundo). Si envias un parche, ¿qué es más lógico? (Por si hay alguien a quien no le resulta evidente la respuesta, he dejado una sencilla pista visual que quizá sólo los más avispados serán capaces de encontrar)

  1. cambiar el formato de todo el archivo, porque en ese proyecto usan tabs, y los que usan tabs no tienen ni idea de la vida
  2. que respetes pero no compartas la indentación con tabs y cuando añadas una linea, te la pelen mil los tabs y como tú sabes que los espacios son mejores, uses espacios.
  3. usar tabs para indentar en ese proyecto en particular (aunque tu opinión sea otra)

Aquí va otro ejemplo, porque habrá quien piense que tiene sentido respetar la indentación del proyecto X si se va a enviar un parche, o se trabaja en un equipo, pero si vas a usar el código de terceros para uso particular no tiene sentido.

Imagina que te bajas la librería open source X, y la integras en tu proyecto. Ahora imagina que le falta la funcionalidad X, y como tardan mucho, pues se la añades tú. Resulta que pasan los meses, y sale una revisión del proyecto X que soluciona 200 bugs. Si has andado por ahí cambiando indentaciones y espacios, integrar los nuevos cambios va a ser más complicado.

Y para finalizar, aquí va la receta:

  • Programa usando 2 o 4 espacios de indentación: incluso si quieres usa tabs con espacios para alinear, pero nunca uses sólo tabs
  • Una vez elijas una convención, sé coherente y usala siempre: no vayas cambiando para unos proyectos u otros, y mucho menos, no vayas cambiando para archivos del mismo proyecto.
  • Si editas proyectos de terceros, incluso si los integras en tu propio proyecto, no cambies la indentación original
  • Y sólo por curiosidad, si te aburres y no has visto los elastic tabstops, échales un vistazo (me ha llamado la atención, que se le va a hacer :p)

Trackback URL

, ,

2 Comments on "Guias de estilo: respeta la indentación original"

Hi Stranger, leave a comment:

ALLOWED XHTML TAGS:

<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Subscribe to Comments