Comentar código fuera de delphi?

[[Al González]]

Creo que estamos ante un despropósito.

No encuentro la relación entre un proyecto con una buena cantidad de formularios y la necesidad de que su código no lleve comentarios. Al contrario, diría que entre más grande es un proyecto, más cuidado se debe tener de que esté debidamente comentado (aparte de la documentación externa al código fuente).

Eso del código autoexplicativo es un concepto con trampa. El código fuente es escrito en un lenguaje que está entre el entendimiento normal humano (un idioma) y la capacidad de análisis de un compilador o intérprete. Se escribe de tal manera que el humano pueda entenderlo, pero concediendo algunas facilidades para que el compilador o intérprete haga su trabajo.

En Delphi, por ejemplo, si escribiésemos el código fuente en inglés normal, sería muy complicado disponer de un compilador capaz de transformar el texto del programa en código máquina. En el otro extremo, si escribiésemos el código solamente con ceros y unos (para una asimilación automática por parte de la computadora), resultaría prácticamente imposible que un programador pudiera leerlo con plena comprensión.

Por ello es que siempre programamos en un lenguaje "intermedio": algo que el compilador pueda procesar, pero que también el humano pueda leer. Claro está, este código fuente debe escribirse de forma comprensible, pero por más claro y ordenado que se encuentre, en muchas ocasiones hará falta algo adicional para quien intente leer ese código fuente, así sea otro programador o el mismo autor tiempo después. Y ese algo adicional son precisamente los comentarios que acompañan al código.

Los comentarios resultan sumamente prácticos porque están ahí, justo al lado del código fuente (arriba, debajo, al costado). Un programador abre un archivo y debe ser capaz de entender (contexto previamente analizado) las sentencias de una rutina, por las sentencias mismas y, ante alguna duda o confusión, por los comentarios que ahí están. Incluso con frecuencia basta, es más rápido y requiere menor esfuerzo neuronal leer el comentario que se encuentra arriba de un If, que el If mismo con todas sus condiciones.

Un comentario fuera del código fuente no es un comentario, es documentación. Pero por más rica que sea la documentación, no se compara con la oportunidad de comprender un bloque de instrucciones debidamente comentado, in situ.

Lepe, yo buscaría convencer a quienes han solicitado eso de lo inadecuado que sería.

Buen martes a todos.

Al González.