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.

  • Si selecciona un código en cualquier lugar, puede escribir un comentario de código en el inspector.

  • 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.

Agregar una definición de código durante la codificación

  • En el área de margen, puede hacer doble clic en un código para abrir el editor de comentarios.

Agregar una definición de código en el área de margen

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.