Main Content

La traducción de esta página aún no se ha actualizado a la versión más reciente. Haga clic aquí para ver la última versión en inglés.

Agregar comentarios al código

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 código, 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.

Agregar comentarios

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

Agregar comentarios en el código

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 en la sección Code, haga clic en el botón de comentario . También puede pulsar Ctrl+R. Para eliminar el comentario de las líneas de código seleccionadas, haga clic en el botón de eliminar el comentario o haga clic en Ctrl+Mayús.+R. En sistemas macOS, utilice Comando+/ para comentar y Comando+Opción+/ para eliminar el comentario. En sistemas Linux®, utilice Ctrl+/ para comentar y Ctrl+Mayús.+/ para eliminar el comentario.

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']

Reajustar comentarios

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. El editor y Live Editor no reajustan los comentarios en:

  • Títulos de las secciones (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

Para cambiar el lugar en el 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. En MATLAB Online™, estas preferencias se ubican en Editor/Debugger > MATLAB Language.

Si tiene comentarios existentes que sobrepasan el ancho actual de la columna, para reajustar automáticamente el comentario, vaya a la pestaña Editor o Live Editor y, en la sección Code, haga clic en el botón de reajustar los comentarios . Por ejemplo, suponga que tiene este texto largo en una línea comentada.

% This is a code file 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 en la sección Code, haga clic en el botón de reajustar los comentarios . El comentario se reajusta en la siguiente línea:
% This is a code file that has a comment that is a little more than 75
% columns wide.
disp('Hello, world')

Verificar ortografía en comentarios

Puede comprobar si existen errores ortográficos en los comentarios. Para habilitar la comprobación de la ortografía, vaya a la pestaña View y haga clic en el botón para activar Spelling. Las palabras con un posible error ortográfico se subrayan en azul. Para resolver el error, haga clic en la palabra y seleccione una de las correcciones sugeridas. También puede elegir ignorar el error o añadir la palabra señalada al diccionario local. Para desplazarse de un error a otro con el teclado, use Alt+F7 y Alt+Shift+F7.

La comprobación de la ortografía es compatible con inglés de Estados Unidos para archivos de código de MATLAB (.m) y archivos de código en vivo (.mlx). Para eliminar palabras del diccionario local, vaya a la carpeta de preferencias de MATLAB (la carpeta devuelta cuando ejecuta prefdir) y edite el archivo dict/en_US_userDictionary.tdi.

Temas relacionados

Sitios web externos