Este wikiHow ensina como criar um documento em pseudocódigo para o seu programa de computador. O pseudocódigo envolve essencialmente a criação de um esboço de linguagem de não programação da intenção do seu código.
Passos
Parte 1 de 3: Noções básicas de pseudocódigo
Etapa 1. Saiba o que é pseudocódigo
Pseudocódigo é um esboço escrito passo a passo de seu código que você pode transcrever gradualmente para a linguagem de programação. Muitos programadores o usam para planejar a função de um algoritmo antes de se comprometerem com a tarefa mais técnica de codificação.
O pseudocódigo serve como um guia informal, uma ferramenta para refletir sobre os problemas do programa e uma opção de comunicação que pode ajudá-lo a explicar suas ideias para outras pessoas.
Etapa 2. Entenda por que o pseudocódigo é útil
Pseudocódigo é usado para mostrar como um algoritmo de computação deve funcionar. Os codificadores geralmente usam o pseudocódigo como uma etapa intermediária na programação, entre o estágio de planejamento inicial e o estágio de escrever o código executável real. Alguns outros usos de pseudocódigo incluem o seguinte:
- Descrever como um algoritmo deve funcionar. O pseudocódigo pode ilustrar onde uma construção, mecanismo ou técnica particular pode ou deve aparecer em um programa.
- Explicando um processo de computação para usuários menos técnicos. Os computadores precisam de uma sintaxe de entrada muito rígida para executar um programa, mas os humanos (especialmente os não programadores) podem achar mais fácil entender uma linguagem mais fluida e subjetiva que declara claramente o propósito de cada linha de código.
- Projetando código em uma configuração de grupo. Os arquitetos de software de alto nível geralmente incluem pseudocódigo em seus projetos para ajudar a resolver um problema complexo que vêem seus programadores enfrentando. Se você estiver desenvolvendo um programa junto com outros programadores, poderá descobrir que o pseudocódigo ajuda a tornar suas intenções claras.
Etapa 3. Lembre-se de que o pseudocódigo é subjetivo e não padrão
Não existe uma sintaxe definida que você absolutamente deva usar para o pseudocódigo, mas é uma cortesia profissional comum usar estruturas de pseudocódigo padrão que outros programadores possam entender facilmente. Se você está codificando um projeto sozinho, o mais importante é que o pseudocódigo o ajude a estruturar seus pensamentos e a executar seu plano.
- Se você estiver trabalhando com outras pessoas em um projeto - sejam eles seus colegas, programadores juniores ou colaboradores não técnicos - é importante usar pelo menos algumas estruturas padrão para que todos possam entender facilmente sua intenção.
- Se você está matriculado em um curso de programação em uma universidade, um campo de programação ou uma empresa, provavelmente será testado em relação a um "padrão" de pseudocódigo ensinado. Esse padrão geralmente varia entre instituições e professores.
Clareza é o objetivo principal do pseudocódigo e pode ajudar se você trabalhar dentro das convenções de programação aceitas. Conforme você desenvolve seu pseudocódigo em código real, você precisará transcrevê-lo para uma linguagem de programação - portanto, ele pode ajudar a estruturar seu esboço com isso em mente.
Etapa 4. Concentre-se no objetivo principal do pseudocódigo
Pode ser fácil voltar a escrever em código, uma vez que você atinge o seu ritmo. Lembrar-se do propósito do seu pseudocódigo - explicar o que cada linha do programa deve fazer - o manterá com os pés no chão enquanto cria o documento do pseudocódigo.
Parte 2 de 3: Escrevendo um bom pseudocódigo
Etapa 1. Use um editor de texto simples
Pode ser tentador usar um processador de texto (por exemplo, Microsoft Word) ou um programa semelhante para criar um documento rich text, mas o pseudocódigo precisa do mínimo de formatação possível para mantê-lo simples.
Os editores de texto simples incluem o Notepad (Windows) e o TextEdit (Mac).
Etapa 2. Comece anotando o propósito do processo
Dedicar uma linha ou duas para explicar o propósito do seu código ajudará a configurar o resto do documento e também o poupará da tarefa de explicar a função do programa para cada pessoa a quem você mostra o pseudocódigo.
Etapa 3. Escreva apenas uma declaração por linha
Cada instrução em seu pseudocódigo deve expressar apenas uma ação para o computador. Na maioria dos casos, se a lista de tarefas for desenhada corretamente, cada tarefa corresponderá a uma linha de pseudocódigo. Considere escrever sua lista de tarefas, traduzir essa lista em pseudocódigo e, em seguida, desenvolver gradualmente esse pseudocódigo em código real legível por computador.
Etapa 4. Use espaço em branco e recuo de forma eficaz
Usar espaços em branco entre os "blocos" de texto ajudará a manter os diferentes componentes do seu pseudocódigo isolados, e recuar diferentes partes de cada bloco indicará que essas partes do pseudocódigo estão em uma seção menos indentada.
Por exemplo, uma seção do pseudocódigo que discute a inserção de um número deve estar no mesmo "bloco", enquanto a próxima seção (por exemplo, a seção que discute a saída) deve estar em um bloco diferente
Etapa 5. Capitalize os comandos de tecla, se necessário
Dependendo dos requisitos do seu pseudocódigo ou do ambiente no qual você está publicando o pseudocódigo, pode ser necessário capitalizar os comandos que permanecerão no código real.
Por exemplo, se você usar os comandos "if" e "then" em seu pseudocódigo, convém alterá-los para "IF" e "THEN" (por exemplo, "IF input number THEN output result")
Etapa 6. Escreva usando uma terminologia simples
Lembre-se de que você está escrevendo sobre o que o projeto fará, não resumindo o código em si. Isso é especialmente importante se você estiver escrevendo pseudocódigo para servir como uma demonstração para um cliente que não conhece programação ou como um projeto para um programador iniciante.
Você pode até querer se livrar de todos os comandos de codificação e apenas definir o processo de cada linha em linguagem simples. Por exemplo, "se a entrada for ímpar, a saída 'Y'" pode se tornar "se o usuário inserir um número ímpar, exiba 'Y'" em vez disso.
Etapa 7. Mantenha seu pseudocódigo na ordem correta
Embora a linguagem que você usa para modificar seu pseudocódigo deva ser simples, você ainda precisa manter cada parte de seu pseudocódigo na ordem em que deve ser executado.
Etapa 8. Não deixe nada para a imaginação
Tudo o que está acontecendo no processo deve ser descrito completamente. As declarações em pseudocódigo são próximas às declarações simples em inglês. O pseudocódigo normalmente não usa variáveis, mas, em vez disso, descreve o que o programa deve fazer com objetos quase reais, como números de contas, nomes ou valores de transação.
Etapa 9. Use estruturas de programação padrão
Mesmo se não houver um padrão para pseudocódigo, será mais fácil para outros programadores entenderem suas etapas se você usar estruturas de linguagens de programação (sequenciais) existentes. Use termos como "if", "then", "while", "else" e "loop" da mesma forma que você faria em sua linguagem de programação preferida. Considere as seguintes estruturas:
- se CONDIÇÃO, então INSTRUÇÃO - Isso significa que uma dada instrução só será conduzida se uma determinada condição for verdadeira. "Instrução", neste caso, significa uma etapa que o programa executará, enquanto "condição" significa que os dados devem atender a um determinado conjunto de critérios antes que o programa execute uma ação.
- enquanto CONDITION faça INSTRUCTION - Isso significa que a instrução deve ser repetida várias vezes até que a condição não seja mais verdadeira.
- faça INSTRUÇÃO enquanto CONDIÇÃO - É muito semelhante a "enquanto CONDIÇÃO faça INSTRUÇÃO". No primeiro caso, a condição é verificada antes da instrução ser conduzida, mas no segundo caso a instrução será conduzida primeiro; assim, no segundo caso, a INSTRUÇÃO será realizada pelo menos uma vez.
- função NOME (ARGUMENTOS): INSTRUÇÃO - Significa que toda vez que um determinado nome é utilizado no código, ele é uma abreviatura de determinada instrução. "Argumentos" são listas de variáveis que você pode usar para esclarecer a instrução.
Etapa 10. Organize suas seções de pseudocódigo
Se você tiver grandes seções de pseudocódigo que definem outras partes do pseudocódigo dentro do mesmo bloco, você pode querer usar colchetes ou outros identificadores para manter tudo contido.
- Os colchetes - padrão (por exemplo, [código]) e curvos (por exemplo, {código}) - podem ajudar a conter longos segmentos de pseudocódigo.
-
Ao codificar, você pode adicionar comentários digitando "" no lado esquerdo do comentário (por exemplo,
// Esta é uma etapa temporária.
- ) Você pode usar esse mesmo método ao escrever pseudocódigo para deixar notas que não cabem no texto de codificação.
Etapa 11. Verifique novamente seu pseudocódigo para legibilidade e clareza
Você deve ser capaz de responder às seguintes perguntas no final do documento:
- Esse pseudocódigo seria compreendido por alguém que não está familiarizado com o processo?
- O pseudocódigo foi escrito de forma que seja fácil traduzi-lo para uma linguagem de computação?
- O pseudocódigo descreve o processo completo sem deixar nada de fora?
- Todos os nomes de objetos usados no pseudocódigo são claramente compreendidos pelo público-alvo?
- Se você achar que uma seção do pseudocódigo precisa ser elaborada ou não descreve explicitamente uma etapa que outra pessoa possa esquecer, volte e adicione as informações necessárias.
Parte 3 de 3: Criando um Exemplo de Documento de Pseudocódigo
Etapa 1. Abra um editor de texto simples
Você pode usar o Bloco de notas (Windows) ou TextEdit (Mac) por padrão se não quiser instalar um novo programa.
Etapa 2. Defina seu programa
Embora não seja estritamente necessário, escrever uma linha de uma ou duas frases na parte superior do documento deixará claro desde o início a intenção do programa:
Este programa irá solicitar uma saudação do usuário. Se a saudação corresponder a uma resposta específica, a resposta será entregue; caso contrário, uma rejeição será entregue.
Etapa 3. Escreva a sequência de abertura
Seu primeiro comando - isto é, a primeira coisa que seu programa deve fazer ao ser executado - deve ser a primeira linha:
imprimir saudação "Olá estranho!"
Etapa 4. Adicione a próxima linha
Coloque um espaço entre a última linha e a próxima pressionando ↵ Enter e, em seguida, crie a próxima linha de código. Neste exemplo, o usuário deve solicitar a próxima linha de diálogo:
prompt de impressão pressione "Enter" para continuar
Etapa 5. Adicione a frase de chamariz
Neste exemplo, o usuário será solicitado a fornecer uma saudação:
imprimir frase de chamariz "Como vai você?"
Etapa 6. Mostre ao usuário uma lista de respostas
Novamente, depois de pressionar ↵ Enter neste exemplo, o usuário deve ver uma lista de respostas possíveis:
exibir respostas possíveis "1. Ótimo." "2. Ótimo!" "3. Não é bom."
Etapa 7. Solicite a entrada do usuário
É aqui que o programa pedirá ao usuário para inserir uma resposta:
imprimir solicitação de entrada "Digite o número que melhor descreve você:"
Etapa 8. Crie comandos "if" para a entrada do usuário
Como há várias respostas que o usuário pode selecionar, você deseja adicionar vários resultados com base na resposta selecionada:
se "1" imprimir a resposta "Dandy!" se "2" imprimir a resposta "Fantástico!" se "3" imprimir a resposta "Ilumine-se, botão de ouro!"
Etapa 9. Adicione uma mensagem de erro
No caso de o usuário escolher incorretamente uma resposta, você pode ter uma mensagem de erro pronta:
se a entrada não for reconhecida, imprimir a resposta "Você não segue as instruções muito bem, não é?"
Etapa 10. Adicione quaisquer outros componentes do programa
Analise o seu documento e acrescente ou dê mais detalhes para garantir que você e qualquer pessoa que esteja lendo o documento entendam seu significado. De acordo com o exemplo deste método, seu documento final em pseudocódigo deve ser semelhante a este:
Este programa irá solicitar uma saudação do usuário. Se a saudação corresponder a uma resposta específica, a resposta será entregue; caso contrário, uma rejeição será entregue. imprimir saudação "Olá estranho!" prompt de impressão pressione "Enter" para continuar
imprimir frase de chamariz "Como você está hoje?" exibir respostas possíveis "1. Ótimo." "2. Ótimo!" "3. Não é bom." print request for input "Digite o número que melhor descreve você:" if "1" print response "Dandy!" se "2" imprimir a resposta "Fantástico!" se "3" imprimir a resposta "Ilumine-se, botão de ouro!" se a entrada não for reconhecida, imprime a resposta "Você não segue as instruções muito bem, não é?"
Etapa 11. Salve seu documento
Pressione Ctrl + S (Windows) ou ⌘ Command + S (Mac), insira um nome e clique Salve para fazer isso.
