PDF de programación - Los principios del programador

developer.*

A Web Magazine for Software Developers

developer.*
A Web Magazine for Software Developers

Los Principios del Programador
by Daniel Read
Translated by Juan A. Romero, University of Cordoba, Spain

Traducido desde English por Juan A. Romero desde el Universidad de Cordoba por
España. Muchas gracias Juan.

El Principio del Carácter Personal

Lo sepamos o no, nos guste o no, nuestro carácter está reflejado en cada línea de código
que escribimos, en cada informe que diseñamos, en cada interfaz de usuario que
construimos, en cada diagrama que hacemos. Cuando otra persona mira nuestro código --
o lo que es tan importante, la salida que produce nuestro código-- esa persona,
conscientemente o no, se hace un juicio de nosotros. Piensa en el código que has escrito
hasta ahora... ¿cuál sería ese juicio? ¿Estarías orgulloso, te pondrías en pie y dirías que
ese código lo has escrito tu? ¿o solo admitirías tímidamente que es tuyo, y lanzarías
excusas de por qué no es lo bueno que debería ser?. Si tu código es malo, alguien que lo
lea probablemente asuma que no es el único código que has hecho mal, que no es lo
único que haces mal. La buena noticia es esta: tenemos control absoluto sobre la calidad
de nuestro código.

La cuestión no es si uno es capaz de escribir el mejor código posible, sino si se
preocupará por intentarlo. Si un programador carece de ciertos conocimientos o de cierta
experiencia, pero hace lo posible por escribir el código de forma clara, entendible, bien
comentada, de forma que muestre que al menos ha invertido tiempo en aprender algunos
fundamentos básicos, entonces habrá actuado como debía con diligencia-- y eso será
obvio para un observador que lea con atención. No es razonable que alguien juzgue mal a
un programador porque le falte algo de experiencia o porque desconozca aún algunas
técnicas. Sin embargo, es absolutamente razonable encontrar una conexión entre la
calidad global del código de un programador y la calidad del carácter de dicho
programador.

El Principio del Carácter Personal establece: Escribe tu código de forma que refleje, y
saque a relucir, solo lo mejor de tu carácter personal.

El Principio de la Estética

Un aspecto de la programación que con frecuencia descuidamos es la estética. La
estética trata sobre la belleza y la elegancia, y de el valor de estas cualidades. Mucha
gente, sin embargo, cree que la estética es solo importante cuando se habla de arte y
literatura. Pocas personas se dan cuenta de la importancia de la belleza y la elegancia en
las cosas cotidianas, y muy pocos programadores se dan cuanta de la importancia de

DeveloperDotStar.com

2003 by the original author

Page 1 of 9

developer.*

A Web Magazine for Software Developers

éstas cuando se escribe código. La estética es especialmente importante en el desarrollo
de software, un terreno en el que siempre estamos tratando con niveles de abstracción.
Los aspectos estéticos de nuestras abstracciones están directamente relacionados con su
entendibilidad y, por lo tanto, con su utilidad.

Un programador debe esforzarse en conseguir la belleza, sin importar la herramienta o el
lenguaje de programación que esté utilizando. La belleza puede conseguirse a muchos
niveles, desde el alto nivel de la elegancia en el diseño del sistema hasta el más bajo nivel
de la apariencia visual del código en la pantalla. Ser ordenado y claro cuenta. El mejor
código no solo funciona de forma correcta y eficiente, y está bien formado desde el punto
de vista del compilador; el mejor código es también agradable de ver por el ojo humano--
y por lo tanto más fácil de absorber y de comprender para el cerebro humano.

Steve McConnell escribe en su libro Code Complete, "El disfrute visual e intelectual de un
código bien formateado es un placer que pocos no-programadores pueden apreciar. Pero
los programadores que se sienten orgullosos de su trabajo experimentan una gran
satisfacción artística puliendo la estructura visual de su código." (Página 399)

El Principio de la Estética establece: Esfuérzate por conseguir la belleza y la elegancia
en cada aspecto de tu trabajo.

El Principio de la Claridad

La claridad en el código es un estado que debemos buscar activamente. Uno de los
mayores delitos que como desarrolladores podemos cometer es olvidar que nuestro
código tiene una vida más allá de los pocos momentos que nos lleva escribirlo. Las
probabilidad de que alguien, posiblemente nosotros mismos, maneje nuestro código en el
futuro son muy altas. Incluso aunque escribamos un código que funciona perfectamente y
nunca causa problemas al usuario, estaremos perjudicando a otros compañeros
desarrolladores (sin mencionar a nuestra empresa) si no escribimos nuestro código de la
forma más clara posible.

Hay una diferencia entre claro y correcto, y muchas veces se confunden. La corrección es
siempre el principal interés del desarrollador, como debe ser. La corrección lleva a que la
sintaxis del código sea correcta a los ojos del compilador, que el diseño de la interfaz
cubra las necesidades del usuario, y que los algoritmos que se implementan cumplan con
sus requerimientos. Pero si no se dedica una atención igual a la claridad, la
comprensibilidad y la mantenibilidad del código sufrirán mucho. Para que nuestro código
sea lo más claro posible, debemos deliberadamente usar técnicas como la utilización de
identificadores descriptivos, la modularidad, la indentación (el sangrado), los espacios en
blanco, la cohesión del código, el acoplamiento débil del código, propiciar la fácil
realización de las pruebas y la documentación, y comentar adecuadamente.

La falta de claridad en nuestro código causa problemas innecesariamente, y también
situaciones profesionalmente embarazosas. A nuestros colegas desarrolladores que
tienen que tratar con nuestro código en años (o incluso décadas) sucesivos. Y a nuestra

DeveloperDotStar.com

2003 by the original author

Page 2 of 9

developer.*

A Web Magazine for Software Developers

empresa, con la que no jugamos limpio devaluándola; incluso en algunos casos nuestro
código puede convertirse en un problema de responsabilidad legal para nuestra empresa.
Dejar a nuestros colegas en esa situación es como mínimo descortés, pero dejar a
nuestra empresa en esa situación es mucho peor: nosotros llegamos al acuerdo de
producir código de calidad por un precio. La empresa ha cumplido pagándonos ese precio
pero, ¿en qué situación sale ella de este acuerdo con nosotros?

El Principio de la Claridad establece: Dale el mismo valor a la claridad que a la
corrección. Utiliza activamente técnicas que mejoran la claridad del código. La corrección
vendrá casi por sí sola.

El Principio de la Distribución

Este principio se refiere a la distribución visual del código. El Principio de la Distribución es
un corolario a los dos principios anteriores: El Principio de la Estética y El Principio de la
Claridad. El Principio de la Estética nos dice que, además del disfrute intelectual que
supone la lectura de código bello y elegante, la propia belleza y la elegancia juegan un
papel crucial para conseguir dicho buen código. Por otro lado, El Principio de la Claridad
nos dice que hagamos nuestro código lo más claro posible a un lector humano, y que la
claridad va de la mano con la corrección. El Principio de la Distribución pone estos dos
principios duales en práctica.

Es difícil discutir la importancia de la distribución visual del código sin referirnos al
principio fundamental de Steve McConnell (Fundamental Theorem of Formating) que
establece: "Una buena distribución visual muestra la estructura lógica de un programa."
(página 403, Code Complete) Esto significa que la distribución visual no solo sirve para
hacer el código visualmente más atractivo, sino que también actúa a nivel del
subconsciente haciendo el código más entendible al lector. El objetivo es reducir la
cantidad de trabajo que un lector necesita para entender el código. La apariencia visual
debe ser nuestra primera herramienta para comunicarnos con claridad con un lector
humano que esté leyendo nuestro código.

Hay varias técnicas que aseguran que la distribución visual del código ayude a entender
su estructura lógica. Estas técnicas deben formar parte de los conocimientos
fundamentales de todo programador: uso adecuado de los espacios en blanco (y líneas
en blanco), indentación, agrupamiento de líneas relacionadas, uso de paréntesis extra
para que las expresiones lógicas y las fórmulas matemáticas sean más claras, márgenes
para alinear el código relacionado de distintas líneas, emplazamiento adecuado de
delimitadores de bloque, etc. Como Steve McConnell sugiere en su teorema, la idea es
utilizar la distribución visual de nuestro código para comunicar a nivel de subconsciente
con el lector. Recuerda que cuando estamos trabajando en el terreno del desarrollo de
software, estamos siempre trabajando con abstracciones, y una abstracción es más útil
cuanto mas entendible es.

El Principio de la Distribución establece: Usa la distribución visual de tu código para
comunicar la estructura de tu código a un lector humano.

DeveloperDotStar.com

2003 by the original author

Page 3 of 9

developer.*

A Web Magazine for Software Developers

El Principio de lo Explícito

Seguir el Principio de lo Explícito nos ahorrará, a nosotros y a nuestros sucesores,
innumerables problemas. El Principio de lo Explícito es un corolario de El Principio de la
Claridad. Pero el Principio de la Claridad nos dice que hagamos nuestro código de forma
clara y entendible para el lector humano. Y el Principio de lo Explícito también se aplica a
esa misma entendibilidad, y a lo que es más importante, a hacer nuestro código más
tolerante a cambios.

Veamos un ejemplo simple: muchos lenguajes de programación ofrecen el concepto de
"fichero". Normalmente el fichero no lo proporciona el lenguaje de programación