Main Content

La traducción de esta página está obsoleta. Haga clic aquí para ver la última versión en inglés.

Agregar comentarios en programas

Cuando escriba código, se recomienda agregar comentarios que lo describan. Los comentarios permiten que otros comprendan el código y, además, pueden refrescar su memoria cuando vuelva a examinarlo más tarde. Durante el desarrollo y las pruebas de programas, también puede utilizar los comentarios para agregar un comentario en el código que no sea necesario ejecutar.

En Live Editor, puede insertar líneas de texto antes y después del código para describir un proceso o código. Las líneas de texto ofrecen mayor flexibilidad, como opciones de formato estándar y la inserción de imágenes, hipervínculos y ecuaciones. Para obtener más información, consulte Crear scripts en vivo en Live Editor.

Nota

Cuando tiene un archivo de código de MATLAB® (.m) que contiene texto con caracteres en una codificación diferente a la de su plataforma, al guardar o publicar el archivo, MATLAB muestra dichos caracteres como texto ilegible. Los scripts y las funciones en vivo (.mlx) admiten el almacenamiento y la visualización de caracteres de todas las configuraciones locales.

Para agregar comentarios en el código de MATLAB, use el símbolo de porcentaje (%). Las líneas de comentarios pueden aparecer en cualquier lugar de un archivo de programa, y se pueden añadir 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.

Para agregar un comentario en varias líneas de código, utilice los operadores de comentario en bloque, %{ y %}. Los operadores %{ y %} deben aparecer solos en las líneas que les preceden inmediatamente y seguir al bloque del texto de ayuda. No incluya ningún otro texto en estas líneas.

Por ejemplo:

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

Para agregar un comentario en una selección, seleccione las líneas de código, vaya a la pestaña Editor o Live Editor y pulse el botón . También puede pulsar Ctrl+R. Para eliminar el comentario del código de las líneas seleccionadas, pulse el botón o pulse Ctrl+T.

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

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

El editor y Live Editor contienen herramientas y elementos de menú contextual para ayudarle a agregar, eliminar o cambiar el formato de los comentarios del código de MATLAB, Java® y C/C++. Por ejemplo, suponga que tiene este texto largo en una línea comentada.

% This is a program that has a comment that is a little more than 75 columns wide.
disp('Hello, world')
Con el cursor en la línea, vaya a la pestaña Editor o Live Editor y pulse el botón . El comentario se reajusta en la siguiente línea:
% 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 y en Live Editor, el texto se reajusta cuando alcanza un ancho de columna de 75. Para cambiar la columna en la que se reajusta el texto de los comentarios o desactivar el reajuste automático de los comentarios, vaya a la pestaña Home y, en la sección Environment, haga clic en Preferences. Seleccione MATLAB > Editor/Debugger > Language y ajuste las preferencias de Comment formatting. Para ajustar las preferencias de Comment formatting en MATLAB Online™, seleccione Editor/Debugger > MATLAB Language.

El editor y Live Editor no reajustan los comentarios en:

  • Títulos de las secciones del código (los comentarios que comienzan por %%)

  • Texto contiguo largo, como las URL

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

Temas relacionados