Esta página aún no se ha traducido para esta versión. Puede ver la versión más reciente de esta página en inglés.

Agregar comentarios a programas

Cuando escribes código, es una buena práctica añadir comentarios que describen el código. Los comentarios permiten que otros comprendan su código y, además, pueden refrescar su memoria cuando deba retomarlo más tarde.

Agregue comentarios al código MATLAB® utilizando el símbolo de porcentaje (%). Las líneas de comentarios pueden aparecer en cualquier parte de un archivo de programa y puede anexar comentarios al final de una línea de código. Por ejemplo:

% Add up all the vector elements. y = sum(x)           % Use the sum function. 

En secuencias de comandos en directo y funciones, también puede describir un proceso o código insertando líneas de texto antes y después del código. Las líneas de texto proporcionan flexibilidad adicional, como las opciones de formato estándar, y la inserción de imágenes, hipervínculos y ecuaciones. Para obtener más información, vea Crear secuencias de comandos en vivo en el editor en directo.

Nota

Cuando se tiene un archivo de código MATLAB (.m) que contiene texto que tiene caracteres en una codificación diferente a la de la plataforma, al guardar o publicar el archivo, MATLAB muestra esos caracteres como texto ilegible. Las funciones y secuencias de comandos en vivo (.mlx) admiten almacenar y mostrar caracteres en todas las configuraciones locales.

Los comentarios también son útiles para el desarrollo y la prueba del programa: comente cualquier código que no necesite ejecutarse. Para comentar varias líneas de código, puede utilizar los operadores de comentarios de bloques, %{ y %}:

a = magic(3); %{ sum(a) diag(a) sum(diag(a)) %} sum(diag(fliplr(a)))

Los operadores %{ y %} deben aparecer solos en las líneas que preceden inmediatamente y siguen el bloque de texto de ayuda. No incluya ningún otro texto en estas líneas.

Para comentar parte de una instrucción que abarca varias líneas, utilice puntos suspensivos (...) en lugar de un signo de porcentaje. Por ejemplo:

header = ['Last Name, ',      ...           'First Name, ',     ...       ... 'Middle Initial, ', ...           'Title']

El editor de MATLAB incluye herramientas y elementos de menú contextual para ayudarle a agregar, quitar o cambiar el formato de los comentarios para el código MATLAB, Java® y C/C++. Por ejemplo, si pega un texto largo en una línea de comentarios, como

% This is a program that has a comment that is a little more than 75 columns wide. disp('Hello, world')
y, a continuación, pulse el botón junto a Comment en la ficha Editor o Live Editor, el editor envuelve el comentario:
% This is a program that has a comment that is a little more than 75 % columns wide. disp('Hello, world')

De forma predeterminada, al escribir comentarios en el editor, el texto se ajusta cuando alcanza un ancho de columna de 75. Para cambiar la columna donde se envuelve el texto del comentario, o para desactivar el ajuste automático de comentarios, ajuste la configuración de preferencias Editor/Debugger Language etiquetada Comment formatting.

El editor no envuelve comentarios con:

  • Títulos de sección de código (comentarios que comienzan con %%)

  • Texto contiguo largo, como URLs

  • Elementos de lista con viñetas (texto que comienza con * o #) en la línea anterior

Los cambios de preferencias no se aplican en el editor en directo.

Ejemplos relacionados

Más acerca de