Como adicionar comentários ao seu script matlab

As pessoas tendem a esquecer as coisas. Você pode saber como seu script MATLAB funciona no dia que você criá-lo e possivelmente até mesmo por uma semana depois disso. No entanto, seis meses abaixo da estrada, você pode achar que você não se lembra muito sobre o roteiro de todo.

Video: MATLAB - Aula 3.2 - Comando Inline e Function

É aí que comentários entram em jogo. Usando comentários ajuda você a se lembrar do que um script faz, por que ele faz isso de uma certa maneira, e até mesmo por que você criou o script em primeiro lugar.

Usando o comentário%

A qualquer momento MATLAB encontra um sinal de porcentagem (%), trata o resto da linha como um comentário. Comentários são simplesmente texto que é usado tanto para descrever o que está acontecendo em um script ou para comente linhas de código que você não deseja executar.

Você pode comentar linhas de código durante o processo de resolução de problemas para determinar se uma determinada linha é a causa de erros em seu script. Aqui, você pode ver como os comentários podem aparecer em um script.

% Diga MATLAB o que mostrar na screen.Prompt = [ `Escreva seu próprio nome, mas somente se ele isn``t`, ... `Wednesday.nType o nome do vizinho`, ... `à sua direita em Wednesday.nHowever, on `... `a quarta-feira com uma lua cheia, digite o`, ...` nomear ofnthe vizinho à sua esquerda! ‘] -% Obter o nome do usuário para que ele possa ser exibido% em screen.Name = input (Prompt,‘s’) -% de saída uma mensagem para fazer o usuário sentir welcome.disp ([‘Olá ‘, Name]) -

Ao executar este código, você vê que os comentários não mudaram a forma como o script funciona. MATLAB também faz comentários fácil de ver, exibindo-os em letras verdes.

Usando o comentário %%

MATLAB suporta um comentário sinal de porcentagem duplo (%%) que suporta a funcionalidade especial em alguns casos. Veja como este comentário funciona:

• Atua como um comando padrão na janela de comando.

• Permite que você execute uma porção (uma seção) do código ao usar o recurso Executar e Advance.

• Cria saída especial ao usar o recurso Publicar.

Usando Executar e Avanço

Quando você adiciona um %% comentar na janela Editor, MATLAB adiciona uma linha de corte acima do comentário (a menos que o comentário aparece na parte superior da janela), efetivamente dividindo o seu código em seções discretas. Para adicionar um comentário seção, você digita %%, um espaço, e o comentário.

Video: Comentários no Matlab

Tal como acontece com comentários padrão, o %% comentário aparece no tipo verde. A linha acima comentário é sua sugestão de que este é um comentário especial. Além disso, a posição do cursor de texto (o ponto de inserção) selecciona uma determinada secção. A secção seleccionada é realçada em um amarelo pálido. Somente a seção selecionada é executada quando você clique em Executar e Advance. Veja como seções funcionam:

1. Coloque o cursor no final do Prompt = linha de código e, em seguida, clique em Executar e Advance.

   Apenas a primeira seção de código é executado. Observe também que o cursor de texto vem para descansar no início da segunda seção.

   

2. Clique em Executar e Advance.

   
   
   
   

   O script exibe uma pergunta rápida para um nome.

3. Digite um nome e pressione Enter.

   Apenas a segunda seção do código é executado. Você não vê a saída script.

4. Coloque o cursor no início da segunda parte e, em seguida, clique em Executar e Advance.

   Passos 2 e 3 se repetem. Você ainda não vê nenhuma saída script.

5. Clique em Executar e Avanço com o cursor de texto no início do terceiro comentário %%.

   Você vê a saída do script (a saída correta, na verdade) sem ser perguntado por um nome.

6. Passo 5 realizar tantas vezes quanto desejado.

   O aplicativo exibe a saída do script de cada vez, sem pedir qualquer informação adicional. Usando esta técnica permite que você execute apenas a parte de um script que você precisa testar em vez de executar todo o script de cada vez.

Você pode fazer pequenas alterações no código e ainda executar uma determinada seção.

informações Publishing

Os comentários de seção permitem documentar facilmente o seu script. Esta seção fornece apenas uma breve visão geral da funcionalidade de publicação, mas demonstra o quão incrível esse recurso realmente é. Para começar, você realmente precisa fazer para criar comentários seção úteis - o tipo que vai fazer sentido como parte de um pacote de documentação.

Ao criar a configuração para o script que você deseja publicar, você precisa definir o formato de saída e alguns fundamentos. O formato padrão é HTML, que é muito bem para este exemplo. No entanto, se você não fizer uma pequena mudança, a saída não vai aparecer muito como você pode gostar dele para olhar.

Na guia Publicar da janela do Editor, clique na seta para baixo em Publicar e escolha Editar Opções de Publicação. Você vê a caixa de diálogo Editar Configurações.

A opção de avaliar o código avalia seu script e emite o resultado como parte da documentação. Infelizmente, MATLAB não é possível avaliar entrada() funciona como parte de publicar a documentação para um script. Como conseqüência, você deve definir avaliar o código para falso. Clique em Publicar. MATLAB produz uma página HTML.

Video: Cómo hacer páginas html de los scripts de Matlab (0015)

Considerando o pouco trabalho que você põe em criar a documentação, ele realmente se parece bastante agradável. Na verdade, ele parece profissional. Ao trabalhar com scripts complexos, documentação como esta realmente servir uma necessidade séria. Depois que você terminar admirando seu trabalho, feche a página HTML ea caixa de diálogo Editar Configurações.