Escribir comentarios de código
Los comentarios de código se pueden usar para diversos propósitos. El uso más habitual es para una definición del código. Si trabaja en equipo, puede añadir también una regla de codificación o una cita de ejemplo. Si trabaja inductivamente, puede usar los comentarios de código para anotar las primeras ideas sobre cómo aplicar ese código. También puede usarlos para redactar resúmenes de todos los segmentos codificados con ese código y su interpretación. Hay varias formas de escribir un comentario de código.
- Agregar un comentario de código al crear un nuevo código en el diálogo de codificación:
Introduzca un nuevo nombre de código y haga clic en el + para crear el código. Ahora puede introducir una descripción o definición de código en el campo de comentario.
- Seleccione un código en el Explorador de proyecto o en el Navegador de códigos. El campo de comentario se muestra debajo de la lista.
- En el área de margen, puede hacer doble clic en un código para abrir el editor de comentarios. Otra opción es hacer clic derecho en un código y seleccionar la opción Editar comentario en el menú contextual. También puede hacer clic en el botón Editar comentario en la cinta de opciones de la pestaña contextual Código.
- Cuando el Administrador de códigos está abierto, puede usar el campo de comentario en la parte inferior de la ventana. Tenga en cuenta que puede alternar entre ver gráficos de barras o los comentarios.
Otra opción es hacer clic derecho en un código en cualquier lugar y seleccionar la opción Editar comentario en el menú contextual.
Todos los códigos que tienen un comentario muestran un pequeño punto amarillo en la parte superior derecha del icono del código.