Ce wikiHow vous apprend à créer un document de pseudocode pour votre programme informatique. Le pseudocode implique essentiellement la création d'un contour de langage non-programmable de l'intention de votre code.
Pas
Partie 1 sur 3: Comprendre les bases du pseudocode
Étape 1. Sachez ce qu'est le pseudocode
Le pseudocode est un aperçu écrit étape par étape de votre code que vous pouvez progressivement transcrire dans le langage de programmation. De nombreux programmeurs l'utilisent pour planifier la fonction d'un algorithme avant de se lancer dans la tâche plus technique de codage.
Le pseudocode sert de guide informel, d'outil pour réfléchir aux problèmes du programme et d'option de communication qui peut vous aider à expliquer vos idées à d'autres personnes.
Étape 2. Comprenez pourquoi le pseudocode est utile
Le pseudocode est utilisé pour montrer comment un algorithme de calcul doit fonctionner. Les codeurs utilisent souvent le pseudocode comme étape intermédiaire de la programmation entre la phase de planification initiale et la phase d'écriture du code exécutable réel. Voici d'autres utilisations du pseudocode:
- Décrire comment un algorithme doit fonctionner. Le pseudocode peut illustrer où une construction, un mécanisme ou une technique particulier pourrait ou doit apparaître dans un programme.
- Expliquer un processus informatique à des utilisateurs moins techniques. Les ordinateurs ont besoin d'une syntaxe d'entrée très stricte pour exécuter un programme, mais les humains (en particulier les non-programmeurs) peuvent trouver plus facile de comprendre un langage plus fluide et subjectif qui indique clairement le but de chaque ligne de code.
- Concevoir du code en groupe. Les architectes logiciels de haut niveau incluront souvent du pseudocode dans leurs conceptions pour aider à résoudre un problème complexe auquel ils voient leurs programmeurs se heurter. Si vous développez un programme avec d'autres codeurs, vous constaterez peut-être que le pseudocode aide à clarifier vos intentions.
Étape 3. N'oubliez pas que le pseudocode est subjectif et non standard
Il n'y a pas de syntaxe définie que vous devez absolument utiliser pour le pseudocode, mais c'est une courtoisie professionnelle courante d'utiliser des structures de pseudocode standard que d'autres programmeurs peuvent facilement comprendre. Si vous codez vous-même un projet, le plus important est que le pseudocode vous aide à structurer vos pensées et à mettre en œuvre votre plan.
- Si vous travaillez avec d'autres sur un projet, qu'il s'agisse de vos pairs, de programmeurs juniors ou de collaborateurs non techniques, il est important d'utiliser au moins quelques structures standard afin que tout le monde puisse facilement comprendre votre intention.
- Si vous êtes inscrit à un cours de programmation dans une université, un camp de codage ou une entreprise, vous serez probablement testé par rapport à un pseudocode "standard" enseigné. Cette norme varie souvent entre les établissements et les enseignants.
La clarté est un objectif principal du pseudocode, et cela peut être utile si vous travaillez dans le cadre des conventions de programmation acceptées. Au fur et à mesure que vous développez votre pseudo-code en code réel, vous devrez le transcrire dans un langage de programmation – cela peut donc vous aider à structurer votre plan dans cet esprit.
Étape 4. Concentrez-vous sur l'objectif principal du pseudocode
Il peut être facile de revenir à l'écriture de code une fois que vous avez atteint votre rythme. En vous rappelant le but de votre pseudo-code, en expliquant ce que chaque ligne du programme doit faire, vous garderez les pieds sur terre lors de la création du document de pseudo-code.
Partie 2 sur 3: Écrire un bon pseudocode
Étape 1. Utilisez un éditeur de texte brut
Il peut être tentant d'utiliser un traitement de texte (par exemple, Microsoft Word) ou un programme similaire pour créer un document en texte enrichi, mais le pseudocode nécessite le moins de formatage possible pour rester simple.
Les éditeurs de texte brut incluent Notepad (Windows) et TextEdit (Mac).
Étape 2. Commencez par écrire le but du processus
Consacrer une ligne ou deux à l'explication du but de votre code aidera à configurer le reste du document, et cela vous évitera également d'expliquer la fonction du programme à chaque personne à qui vous montrez le pseudocode.
Étape 3. Écrivez une seule déclaration par ligne
Chaque déclaration de votre pseudocode doit exprimer une seule action pour l'ordinateur. Dans la plupart des cas, si la liste des tâches est correctement dessinée, alors chaque tâche correspondra à une ligne de pseudocode. Envisagez de rédiger votre liste de tâches, puis de traduire cette liste en pseudocode, puis de développer progressivement ce pseudocode en code réel lisible par ordinateur.
Étape 4. Utilisez efficacement l'espace blanc et l'indentation
L'utilisation d'espaces blancs entre les « blocs » de texte aidera à isoler les différents composants de votre pseudocode, et l'indentation de différentes parties de chaque bloc indiquera que ces éléments de pseudocode se trouvent dans une section moins indentée.
Par exemple, une section de pseudocode qui traite de la saisie d'un nombre doit être dans le même "bloc", tandis que la section suivante (par exemple, la section qui traite de la sortie) doit être dans un bloc différent
Étape 5. Capitalisez les raccourcis clavier si nécessaire
En fonction de vos exigences en matière de pseudocode ou de l'environnement dans lequel vous publiez le pseudocode, vous devrez peut-être capitaliser les commandes qui resteront dans le code réel.
Par exemple, si vous utilisez les commandes "if" et "then" dans votre pseudocode, vous voudrez peut-être les changer pour lire "IF" et "ALORS" (par exemple, "IF numéro d'entrée ALORS résultat de sortie")
Étape 6. Écrivez en utilisant une terminologie simple
N'oubliez pas que vous écrivez sur ce que le projet fera, sans résumer le code lui-même. Ceci est particulièrement important si vous écrivez du pseudocode pour servir de démonstration à un client qui ne connaît pas le codage, ou comme projet pour un programmeur débutant.
Vous voudrez peut-être même vous débarrasser complètement de toutes les commandes de codage et définir simplement le processus de chaque ligne en langage clair. Par exemple, "si l'entrée est impaire, la sortie 'Y'" peut devenir "si l'utilisateur entre un nombre impair, afficher 'Y'" à la place.
Étape 7. Conservez votre pseudo-code dans le bon ordre
Bien que le langage que vous utilisez pour modifier votre pseudocode doive être simple, vous devez toujours conserver chaque élément de votre pseudocode dans l'ordre dans lequel il doit être exécuté.
Étape 8. Ne laissez rien à l'imagination
Tout ce qui se passe dans le processus doit être décrit complètement. Les déclarations de pseudocode sont proches des déclarations anglaises simples. Le pseudocode n'utilise généralement pas de variables, mais décrit plutôt ce que le programme doit faire avec des objets proches du monde réel tels que des numéros de compte, des noms ou des montants de transaction.
Étape 9. Utilisez des structures de programmation standard
Même s'il n'y a pas de norme pour le pseudocode, il sera plus facile pour les autres programmeurs de comprendre vos étapes si vous utilisez des structures de langages de programmation (séquentielles) existants. Utilisez des termes comme « si », « alors », « pendant », « autrement » et « boucler » de la même manière que vous le feriez dans votre langage de programmation préféré. Considérez les structures suivantes:
- if CONDITION then INSTRUCTION - Cela signifie qu'une instruction donnée ne sera exécutée que si une condition donnée est vraie. "Instruction", dans ce cas, signifie une étape que le programme exécutera, tandis que "condition" signifie que les données doivent répondre à un certain ensemble de critères avant que le programme n'agisse.
- while CONDITION do INSTRUCTION - Cela signifie que l'instruction doit être répétée encore et encore jusqu'à ce que la condition ne soit plus vraie.
- do INSTRUCTION while CONDITION - Ceci est très similaire à "while CONDITION do INSTRUCTION". Dans le premier cas, la condition est vérifiée avant que l'instruction ne soit exécutée, mais dans le second cas, l'instruction sera exécutée en premier; ainsi, dans le second cas, INSTRUCTION sera effectuée au moins une fois.
- fonction NOM (ARGUMENTS): INSTRUCTION - Cela signifie que chaque fois qu'un certain nom est utilisé dans le code, il s'agit d'une abréviation pour une certaine instruction. Les "arguments" sont des listes de variables que vous pouvez utiliser pour clarifier l'instruction.
Étape 10. Organisez vos sections de pseudocode
Si vous avez de grandes sections de pseudocode qui définissent d'autres morceaux de pseudocode dans le même bloc, vous voudrez peut-être utiliser des crochets ou d'autres identifiants pour conserver tout ce qu'il contient.
- Les crochets - à la fois standard (par exemple, [code]) et incurvés (par exemple, {code}) - peuvent aider à contenir de longs segments de pseudocode.
-
Lors du codage, vous pouvez ajouter des commentaires en tapant "" sur le côté gauche du commentaire (par exemple,
//Ceci est une étape temporaire.
- ). Vous pouvez utiliser cette même méthode lors de l'écriture du pseudocode pour laisser des notes qui ne rentrent pas dans le texte de codage.
Étape 11. Vérifiez la lisibilité et la clarté de votre pseudocode
Vous devriez être en mesure de répondre aux questions suivantes à la fin du document:
- Ce pseudo-code serait-il compris par quelqu'un qui n'est pas familier avec le processus ?
- Le pseudocode est-il écrit de telle manière qu'il soit facile de le traduire dans un langage informatique ?
- Le pseudocode décrit-il le processus complet sans rien laisser de côté ?
- Chaque nom d'objet utilisé dans le pseudocode est-il clairement compris par le public cible ?
- Si vous trouvez qu'une section de pseudocode a besoin d'être élaborée ou qu'elle ne décrit pas explicitement une étape que quelqu'un d'autre pourrait oublier, revenez en arrière et ajoutez les informations nécessaires.
Partie 3 sur 3: Création d'un exemple de document de pseudocode
Étape 1. Ouvrez un éditeur de texte brut
Vous pouvez utiliser le Bloc-notes (Windows) ou TextEdit (Mac) par défaut si vous ne souhaitez pas installer un nouveau programme.
Étape 2. Définissez votre programme
Bien que cela ne soit pas strictement nécessaire, l'écriture d'une ligne d'une ou deux phrases en haut du document indiquera clairement dès le début l'intention du programme:
Ce programme demandera un message d'accueil à l'utilisateur. Si le message d'accueil correspond à une réponse spécifique, la réponse sera livrée; sinon, un refus sera délivré.
Étape 3. Écrivez la séquence d'ouverture
Votre première commande, c'est-à-dire la première chose que votre programme doit faire lors de son exécution, doit être la première ligne:
impression salutation "Bonjour étranger !"
Étape 4. Ajoutez la ligne suivante
Placez un espace entre la dernière ligne et la suivante en appuyant sur ↵ Entrée, puis créez la ligne de code suivante. Dans cet exemple, l'utilisateur doit afficher la ligne de dialogue suivante:
imprimer l'invite appuyez sur "Entrée" pour continuer
Étape 5. Ajoutez l'appel à l'action
Dans cet exemple, l'utilisateur sera invité à saisir un message d'accueil:
imprimer l'appel à l'action « Comment allez-vous ? »
Étape 6. Montrez à l'utilisateur une liste de réponses
Encore une fois, après avoir appuyé sur ↵ Entrée dans cet exemple, l'utilisateur devrait voir une liste de réponses possibles:
afficher les réponses possibles "1. Bien." "2. Super !" "3. Pas bien."
Étape 7. Demander l'entrée de l'utilisateur
C'est ici que le programme demandera à l'utilisateur de saisir une réponse:
imprimer la demande de saisie « Entrez le numéro qui vous décrit le mieux: »
Étape 8. Créez des commandes "if" pour l'entrée de l'utilisateur
Étant donné que l'utilisateur peut sélectionner plusieurs réponses, vous souhaiterez ajouter plusieurs résultats en fonction de la réponse sélectionnée:
si "1" imprime la réponse "Dandy!" si "2" imprime la réponse "Fantastique !" si "3" imprimez la réponse "Éclairez-vous, renoncule !"
Étape 9. Ajoutez un message d'erreur
Dans le cas où l'utilisateur choisit une réponse de manière incorrecte, vous pouvez avoir un message d'erreur prêt:
si l'entrée n'est pas reconnue, imprimez la réponse « Vous ne suivez pas très bien les instructions, n'est-ce pas ? »
Étape 10. Ajoutez tous les autres composants du programme
Parcourez votre document et ajoutez ou étoffez tous les détails pour vous assurer que vous et toute personne lisant le document en comprendrez le sens. Selon l'exemple de cette méthode, votre document de pseudocode final devrait ressembler à ceci:
Ce programme demandera un message d'accueil à l'utilisateur. Si le message d'accueil correspond à une réponse spécifique, la réponse sera livrée; sinon, un refus sera délivré. impression salutation "Bonjour étranger !" imprimer l'invite appuyez sur "Entrée" pour continuer
print call-to-action "Comment allez-vous aujourd'hui ?" afficher les réponses possibles "1. Bien." "2. Super !" "3. Pas bien." imprimer la demande de saisie « Entrez le numéro qui vous décrit le mieux: » si « 1 » imprimez la réponse « Dandy ! » si "2" imprime la réponse "Fantastique !" si "3" imprimez la réponse "Éclairez-vous, renoncule !" si l'entrée n'est pas reconnue, imprimez la réponse « Vous ne suivez pas très bien les instructions, n'est-ce pas ? »
Étape 11. Enregistrez votre document
Appuyez sur Ctrl+S (Windows) ou ⌘ Commande+S (Mac), saisissez un nom et cliquez sur sauvegarder faire cela.
