Article on other languages:
- تعليق_(برمجة)
- Kommentar_(Programmierung)
- Comment_(computer_programming)
- Commentaire_(informatique)
- Commentaar_(programmeren)
- コメント_(コンピュータ)
- Komentarz_(informatyka)
- Комментарии_(программирование)
 |
del.icio.us |
 |
Digg |
 |
Furl |
 |
|
 |
Rojo |
| Add to OnlyWire |
 |
Este artículo o sección necesita fuentes o referencias que aparezcan en una publicación acreditada, como libros de texto u otras publicaciones especializadas en el tema. Puedes dar aviso al autor principal del artículo pegando el siguiente código en su página de discusión: {{subst:Aviso referencias|Comentario (programación de computadores)}} ~~~~ |
En la programación de computadoras, un comentario es una construcción del lenguaje de programación destinada a integrar información adicional en el código fuente de un programa. En la mayoría de los casos, cuando el código fuente es procesado por un compilador o intérprete, los comentarios no se toman en cuenta.
Los comentarios tienen una amplia gama de posibles usos: desde la mejora del código fuente con descripciones básicas hasta la generación de documentación externa. También se utilizan para la integración con sistemas de control de versiones y otros tipos de herramientas de programación externas.
La flexibilidad proporcionada por los comentarios da pie a un amplio abanico de formas de uso distintas y a la inclusión de información inútil dentro del código fuente. Para evitar este inconveniente, muchos programadores y analistas de software recomiendan adoptar "filosofías" o métodologías para la correcta utilización de los comentarios.
Contenido |
Descripción
El código fuente se puede dividir conceptualmente en código fuente (consistente en instrucciones inteligibles por la computadora) y comentarios (que consisten en notas inteligibles por el ser humano, además de ciertas anotaciones para dar soporte al código fuente). Las reglas y sintáxis de ambos están descritas en la especificación del lenguaje de programación.
Los comentarios adoptan por norma general un formato bien de "bloque" (también denominado de "prólogo") o bien de "línea" (también denominado "inline") .
Un comentario de bloque delimita una zona del código fuente compuesta por varias líneas de texto. Esta región se reconoce por un delimitador de inicio y un delimitador de final del comentario. Algunos lenguajes de programación admiten que los comentarios se aniden unos dentro de otros (e.g., MATLAB), pero otros lenguajes (e.g., Java) no lo admiten.
Un comentario de línea comienza con un delimitador y continúa hasta el final de la línea de texto (es decir, no es necesario un segundo delimitador). En algunos lenguajes, el comentario de línea siempre comienza en una cierta columna no siendo necesario un delimitador.
Los delimitadores son una secuencia conocida de uno, dos o tres caracteres y suelen ser distintos para los comentarios de bloque y de línea. Por ejemplo, el lenguaje C++ usa los delimitadores /* y */ para los comentarios de bloque mientras que los comentarios de línea utilizan el delimitador //. Otros lenguajes solamente admiten un tipo de comentario. Por ejemplo, ADA solamente dispone de comentarios de línea mediante el delimitador --.
Usos
La manera de dar uso a los comentarios es objeto de controversia con posiciones a menudo enfrentadas.
A continuación se describen los usos más habituales.
Estilos
Hay muchas alternativas cuando se considera como los comentarios deben aparecer en el código fuente. Para grandes proyectos, los estilos de los comentarios se agregan apenas comienzan el proyecto. Normalmente los programadores prefieren estilos que son consistentes, no obstructivos, fáciles de modificar, y difíciles de romper.
Los siguientes fragmentos de codigo en C son solo un ejemplo de como los comentarios pueden variar de estilo, mientras todos contienen la misma información básica:
/*
Este es el cuerpo del comentario.
Variante 1
*/
/***********************************\
* *
* Este es el cuerpo del comentario. *
* Variante 2. *
* *
\************************************/
Descripción del código fuente
Los comentarios pueden ser utilizados para resumir un fragmento de código o explicar cuál es su función. De acuerdo con algunas "escuelas de pensamiento" esto es superfluo. La necesidad de explicar qué hace el código puede ser un signo de que es demasiado complejo y debe ser re-escrito.
También puede usarse los comentarios para explicar por qué un bloque de código no se ajusta a estándares o buenas prácticas. Esto es especialmente cierto en proyectos desarrollados rápidamente o para la circunvención de fallos conocidos. Por ejemplo:
