Los comentarios generalmente se dividen en comentarios introductorios y ¿qué?
Nota: Es texto que introduce, anota o explica el código fuente. Los comentarios son la memoria del programador o una descripción sugerente del código fuente, que está destinada a que la gente la vea. Puede decirles a los desarrolladores la lógica, descripción, características, etc. de este código, y desempeñar un papel en la explicación y explicación del código.
Comentarios del prefacio
Generalmente se colocan al comienzo de cada módulo del programa y describen principalmente:
1.
2. Interfaz del módulo: incluye el formato de llamada, la descripción de los parámetros y los nombres de otros submódulos que el módulo necesita llamar.
3. Variables locales importantes: incluyendo usos, restricciones y limitaciones.
4. Historial de desarrollo: incluido el diseñador, revisor, fecha de revisión, fecha de modificación y descripción de modificación del módulo.
Usualmente ubicado al comienzo de cada módulo del programa, debe proporcionar una descripción general del programa y servir como guía para comprender el programa en sí.
Comentarios funcionales
Generalmente integrados en el programa fuente, describen principalmente la función del segmento del programa. Cuestiones a las que se debe prestar atención al escribir comentarios de funciones
1. Las anotaciones deben ser correctas, las anotaciones incorrectas son peores que ninguna anotación;
2. Comentar segmentos del programa, no cada declaración;
p>
3. Utilice sangría y líneas en blanco para distinguir programas y comentarios.
4. Los comentarios deben proporcionar alguna información que sea difícil de obtener del propio programa, en lugar de repetir frases.
Los comentarios funcionales están incrustados en el cuerpo del programa fuente y describen qué están haciendo las siguientes declaraciones o segmentos del programa, o qué sucederá cuando se ejecuten las siguientes declaraciones, sin explicar qué hacer a continuación.
El programa fuente, también conocido como código fuente, se refiere a un archivo de texto no compilado escrito de acuerdo con ciertas especificaciones del lenguaje de programación. Es una serie de instrucciones en lenguaje informático legibles por humanos. El objetivo final de un programa fuente de computadora es traducir texto legible por humanos en instrucciones binarias que una computadora pueda ejecutar. Este proceso se llama compilación y lo realiza el compilador.
Cuando el código es muy largo, especialmente cuando hay varios nidos, se deben añadir comentarios al final de determinados párrafos para facilitar la lectura.