In diesem wikiHow zeigen wir dir, wie du ein Pseudocode-Dokument für dein Computerprogramm erstellst. Pseudocode beinhaltet im Wesentlichen das Erstellen einer nicht programmiersprachlichen Umrisse der Absicht Ihres Codes.
Schritte
Teil 1 von 3: Grundlagen des Pseudocodes verstehen
Schritt 1. Wissen Sie, was Pseudocode ist
Pseudocode ist eine schrittweise geschriebene Gliederung Ihres Codes, die Sie nach und nach in die Programmiersprache transkribieren können. Viele Programmierer verwenden es, um die Funktion eines Algorithmus zu planen, bevor sie sich der eher technischen Aufgabe des Codierens widmen.
Pseudocode dient als informeller Leitfaden, ein Werkzeug zum Durchdenken von Programmproblemen und eine Kommunikationsmöglichkeit, die Ihnen helfen kann, Ihre Ideen anderen Leuten zu erklären.
Schritt 2. Verstehen Sie, warum Pseudocode nützlich ist
Pseudocode wird verwendet, um zu zeigen, wie ein Rechenalgorithmus funktionieren sollte. Programmierer verwenden Pseudocode häufig als Zwischenschritt bei der Programmierung zwischen der anfänglichen Planungsphase und der Phase des Schreibens von tatsächlich ausführbarem Code. Einige andere Verwendungen von Pseudocode umfassen Folgendes:
- Beschreiben, wie ein Algorithmus funktionieren soll. Pseudocode kann veranschaulichen, wo ein bestimmtes Konstrukt, ein Mechanismus oder eine Technik in einem Programm erscheinen könnte oder muss.
- Erklären eines Computerprozesses für weniger technisch versierte Benutzer. Computer benötigen eine sehr strenge Eingabesyntax, um ein Programm auszuführen, aber Menschen (insbesondere Nicht-Programmierer) finden es möglicherweise einfacher, eine flüssigere, subjektive Sprache zu verstehen, die den Zweck jeder Codezeile klar angibt.
- Entwerfen von Code in einer Gruppenumgebung. Hochrangige Softwarearchitekten integrieren häufig Pseudocode in ihre Designs, um ein komplexes Problem zu lösen, auf das ihre Programmierer stoßen. Wenn Sie zusammen mit anderen Programmierern ein Programm entwickeln, stellen Sie möglicherweise fest, dass Pseudocode Ihre Absichten deutlich macht.
Schritt 3. Denken Sie daran, dass Pseudocode subjektiv und nicht standardisiert ist
Es gibt keine festgelegte Syntax, die Sie unbedingt für Pseudocode verwenden müssen, aber es ist eine übliche professionelle Höflichkeit, Standard-Pseudocode-Strukturen zu verwenden, die andere Programmierer leicht verstehen können. Wenn Sie ein Projekt selbst codieren, ist das Wichtigste, dass der Pseudocode Ihnen hilft, Ihre Gedanken zu strukturieren und Ihren Plan umzusetzen.
- Wenn Sie mit anderen an einem Projekt arbeiten – seien es Kollegen, Junior-Programmierer oder nicht-technische Mitarbeiter – ist es wichtig, zumindest einige Standardstrukturen zu verwenden, damit alle anderen Ihre Absicht leicht verstehen können.
- Wenn Sie in einem Programmierkurs an einer Universität, einem Programmiercamp oder einem Unternehmen eingeschrieben sind, werden Sie wahrscheinlich gegen einen gelehrten Pseudocode-"Standard" getestet. Dieser Standard variiert oft zwischen Institutionen und Lehrern.
Klarheit ist ein Hauptziel von Pseudocode, und es kann hilfreich sein, wenn Sie innerhalb anerkannter Programmierkonventionen arbeiten. Wenn Sie Ihren Pseudocode zu echtem Code entwickeln, müssen Sie ihn in eine Programmiersprache transkribieren – es kann also hilfreich sein, Ihre Gliederung unter Berücksichtigung dieser Aspekte zu strukturieren.
Schritt 4. Konzentrieren Sie sich auf den Hauptzweck von Pseudocode
Es kann einfach sein, wieder in Code zu schreiben, sobald Sie Ihren Schritt gemacht haben. Wenn Sie sich an den Zweck Ihres Pseudocodes erinnern – erklären, was jede Zeile des Programms tun soll – werden Sie beim Erstellen des Pseudocode-Dokuments auf dem Boden bleiben.
Teil 2 von 3: Guten Pseudocode schreiben
Schritt 1. Verwenden Sie einen Nur-Text-Editor
Es kann verlockend sein, ein Textverarbeitungsprogramm (z. B. Microsoft Word) oder ein ähnliches Programm zu verwenden, um ein Rich-Text-Dokument zu erstellen, aber Pseudocode benötigt so wenig Formatierung wie möglich, um es einfach zu halten.
Zu den Nur-Text-Editoren gehören Notepad (Windows) und TextEdit (Mac).
Schritt 2. Beginnen Sie damit, den Zweck des Prozesses aufzuschreiben
Wenn Sie ein oder zwei Zeilen der Erklärung des Zwecks Ihres Codes widmen, können Sie den Rest des Dokuments einrichten und es erspart Ihnen auch die Aufgabe, die Funktion des Programms jeder Person zu erklären, der Sie den Pseudocode zeigen.
Schritt 3. Schreiben Sie nur eine Anweisung pro Zeile
Jede Anweisung in Ihrem Pseudocode sollte nur eine Aktion für den Computer ausdrücken. In den meisten Fällen entspricht jede Aufgabe einer Zeile Pseudocode, wenn die Aufgabenliste richtig gezeichnet ist. Erwägen Sie, Ihre Aufgabenliste zu schreiben, diese Liste dann in Pseudocode zu übersetzen und diesen Pseudocode dann schrittweise in tatsächlichen, computerlesbaren Code zu entwickeln.
Schritt 4. Verwenden Sie Leerräume und Einrückungen effektiv
Die Verwendung von Leerzeichen zwischen "Textblöcken" hilft dabei, verschiedene Komponenten Ihres Pseudocodes isoliert zu halten, und das Einrücken verschiedener Teile jedes Blocks zeigt an, dass diese Teile des Pseudocodes unter einen weniger eingerückten Abschnitt gehören.
Zum Beispiel sollte ein Abschnitt von Pseudocode, der die Eingabe einer Zahl behandelt, alle in demselben "Block" sein, während der nächste Abschnitt (z. B. der Abschnitt, der die Ausgabe behandelt) in einem anderen Block sein sollte
Schritt 5. Geben Sie Tastenbefehle bei Bedarf in Großbuchstaben ein
Abhängig von Ihren Pseudocode-Anforderungen oder der Umgebung, in der Sie den Pseudocode veröffentlichen, müssen Sie Befehle, die im eigentlichen Code verbleiben, möglicherweise groß schreiben.
Wenn Sie beispielsweise die Befehle "if" und "then" in Ihrem Pseudocode verwenden, möchten Sie sie möglicherweise in "IF" und "THEN" ändern (z. B. "IF Eingabenummer DANN Ausgabeergebnis")
Schritt 6. Schreiben Sie mit einfacher Terminologie
Denken Sie daran, dass Sie darüber schreiben, was das Projekt tun wird, und nicht den Code selbst zusammenfassen. Dies ist besonders wichtig, wenn Sie Pseudocode schreiben, um als Demonstration für einen Kunden zu dienen, der keine Programmierkenntnisse hat, oder als Projekt für einen Programmieranfänger.
Vielleicht möchten Sie sogar alle Codierungsbefehle ganz loswerden und einfach den Prozess jeder Zeile in einfacher Sprache definieren. Beispiel: "Wenn die Eingabe ungerade ist, wird die Ausgabe 'Y'" zu "Wenn der Benutzer eine ungerade Zahl eingibt, zeige stattdessen 'Y'" an.
Schritt 7. Halten Sie Ihren Pseudocode in der richtigen Reihenfolge
Obwohl die Sprache, die Sie zum Ändern Ihres Pseudocodes verwenden, einfach sein sollte, müssen Sie dennoch jeden Teil Ihres Pseudocodes in der Reihenfolge halten, in der er ausgeführt werden muss.
Schritt 8. Überlassen Sie nichts der Fantasie
Alles, was dabei passiert, muss vollständig beschrieben werden. Pseudocode-Anweisungen ähneln einfachen englischen Anweisungen. Pseudocode verwendet normalerweise keine Variablen, sondern beschreibt stattdessen, was das Programm mit realitätsnahen Objekten wie Kontonummern, Namen oder Transaktionsbeträgen tun soll.
Schritt 9. Verwenden Sie Standardprogrammierungsstrukturen
Auch wenn es keinen Standard für Pseudocode gibt, ist es für andere Programmierer einfacher, Ihre Schritte zu verstehen, wenn Sie Strukturen aus bestehenden (sequentiellen) Programmiersprachen verwenden. Verwenden Sie Begriffe wie "if", "then", "while", "else" und "loop" wie in Ihrer bevorzugten Programmiersprache. Betrachten Sie die folgenden Strukturen:
- if CONDITION then INSTRUCTION - Dies bedeutet, dass eine gegebene Anweisung nur ausgeführt wird, wenn eine gegebene Bedingung wahr ist. "Anweisung" bedeutet in diesem Fall einen Schritt, den das Programm ausführen wird, während "Bedingung" bedeutet, dass die Daten einen bestimmten Satz von Kriterien erfüllen müssen, bevor das Programm eine Aktion ausführt.
- while CONDITION do INSTRUCTION - Dies bedeutet, dass die Anweisung immer wieder wiederholt werden soll, bis die Bedingung nicht mehr erfüllt ist.
- do INSTRUCTION while CONDITION - Dies ist sehr ähnlich zu "während CONDITION INSTRUCTION ausführen". Im ersten Fall wird die Bedingung geprüft, bevor die Anweisung ausgeführt wird, im zweiten Fall wird die Anweisung jedoch zuerst ausgeführt; daher wird im zweiten Fall die ANWEISUNG mindestens einmal durchgeführt.
- Funktion NAME (ARGUMENTE): ANWEISUNG - Dies bedeutet, dass jedes Mal, wenn ein bestimmter Name im Code verwendet wird, es eine Abkürzung für eine bestimmte Anweisung ist. "Argumente" sind Variablenlisten, mit denen Sie die Anweisung verdeutlichen können.
Schritt 10. Organisieren Sie Ihre Pseudocode-Abschnitte
Wenn Sie große Pseudocode-Abschnitte haben, die andere Pseudocode-Teile innerhalb desselben Blocks definieren, möchten Sie vielleicht Klammern oder andere Bezeichner verwenden, um alles enthalten zu halten.
- Klammern – sowohl Standard- (z. B. [Code]) als auch gebogene (z. B. {Code})) – können dabei helfen, lange Pseudocode-Segmente zu enthalten.
-
Beim Codieren können Sie Kommentare hinzufügen, indem Sie auf der linken Seite des Kommentars "" eingeben (z. B.
//Dies ist ein temporärer Schritt.
- ). Sie können dieselbe Methode verwenden, wenn Sie Pseudocode schreiben, um Notizen zu hinterlassen, die nicht in den Codierungstext passen.
Schritt 11. Überprüfen Sie Ihren Pseudocode auf Lesbarkeit und Klarheit
Am Ende des Dokuments sollten Sie folgende Fragen beantworten können:
- Würde dieser Pseudocode von jemandem verstanden werden, der mit dem Verfahren nicht vertraut ist?
- Ist der Pseudocode so geschrieben, dass er leicht in eine Computersprache übersetzt werden kann?
- Beschreibt der Pseudocode den kompletten Vorgang, ohne etwas auszulassen?
- Wird jeder im Pseudocode verwendete Objektname von der Zielgruppe klar verstanden?
- Wenn Sie feststellen, dass ein Abschnitt des Pseudocodes ausgearbeitet werden muss oder einen Schritt nicht explizit umreißt, den jemand vergessen könnte, gehen Sie zurück und fügen Sie die erforderlichen Informationen hinzu.
Teil 3 von 3: Erstellen eines Pseudocode-Beispieldokuments
Schritt 1. Öffnen Sie einen Nur-Text-Editor
Sie können standardmäßig Notepad (Windows) oder TextEdit (Mac) verwenden, wenn Sie kein neues Programm installieren möchten.
Schritt 2. Definieren Sie Ihr Programm
Obwohl dies nicht unbedingt erforderlich ist, wird das Schreiben einer Zeile mit einem oder zwei Sätzen am Anfang des Dokuments von Anfang an die Absicht des Programms deutlich machen:
Dieses Programm fordert eine Begrüßung vom Benutzer an. Wenn die Begrüßung mit einer bestimmten Antwort übereinstimmt, wird die Antwort zugestellt; falls nicht, erfolgt eine Absage.
Schritt 3. Schreiben Sie die Eröffnungssequenz
Ihr erster Befehl – d. h. das erste, was Ihr Programm beim Ausführen tun sollte – sollte die erste Zeile sein:
Gruß drucken "Hallo Fremder!"
Schritt 4. Fügen Sie die nächste Zeile hinzu
Setze ein Leerzeichen zwischen der letzten und der nächsten Zeile ein, indem du Enter drückst, und erstelle dann die nächste Codezeile. In diesem Beispiel sollte der Benutzer die nächste Dialogzeile aufrufen:
Eingabeaufforderung drucken drücken Sie "Enter", um fortzufahren
Schritt 5. Fügen Sie den Call-to-Action hinzu
In diesem Beispiel wird der Benutzer zu einer Begrüßung aufgefordert:
Call-to-Action drucken "Wie geht es dir?"
Schritt 6. Zeigen Sie dem Benutzer eine Liste mit Antworten
Auch in diesem Beispiel sollte der Benutzer nach Drücken von ↵ Enter eine Liste mit möglichen Antworten sehen:
mögliche Antworten anzeigen "1. Gut." "2. Großartig!" "3. Nicht gut."
Schritt 7. Eingabe vom Benutzer anfordern
Hier fordert das Programm den Benutzer auf, eine Antwort einzugeben:
Druckaufforderung zur Eingabe "Geben Sie die Nummer ein, die Sie am besten beschreibt:"
Schritt 8. Erstellen Sie "if"-Befehle für die Eingabe des Benutzers
Da der Benutzer mehrere Antworten auswählen kann, sollten Sie basierend auf der ausgewählten Antwort mehrere Ergebnisse hinzufügen:
wenn "1" Antwort drucken "Dandy!" if "2" Antwort drucken "Fantastisch!" if "3" Antwort drucken "Aufhellen, Butterblume!"
Schritt 9. Fügen Sie eine Fehlermeldung hinzu
Für den Fall, dass der Benutzer eine Antwort falsch auswählt, können Sie eine Fehlermeldung parat haben:
wenn Eingabe nicht erkannt wird Antwort drucken "Sie befolgen die Anweisungen nicht sehr gut, oder?"
Schritt 10. Fügen Sie alle anderen Komponenten des Programms hinzu
Gehen Sie Ihr Dokument durch und ergänzen oder ergänzen Sie alle Details, um sicherzustellen, dass sowohl Sie als auch alle, die das Dokument lesen, seine Bedeutung verstehen. Gemäß dem Beispiel dieser Methode sollte Ihr endgültiges Pseudocode-Dokument etwa so aussehen:
Dieses Programm fordert eine Begrüßung vom Benutzer an. Wenn die Begrüßung mit einer bestimmten Antwort übereinstimmt, wird die Antwort zugestellt; falls nicht, erfolgt eine Absage. Gruß drucken "Hallo Fremder!" Eingabeaufforderung drucken drücken Sie "Enter", um fortzufahren
Call-to-Action drucken "Wie geht es Ihnen heute?" mögliche Antworten anzeigen "1. Gut." "2. Großartig!" "3. Nicht gut." Druckaufforderung für Eingabe "Geben Sie die Zahl ein, die Sie am besten beschreibt:" wenn "1" Antwort drucken "Dandy!" if "2" Antwort drucken "Fantastisch!" if "3" Antwort drucken "Aufhellen, Butterblume!" wenn Eingabe nicht erkannt wird Antwort drucken "Sie befolgen die Anweisungen nicht sehr gut, oder?"
Schritt 11. Speichern Sie Ihr Dokument
Drücke Strg+S (Windows) oder ⌘ Command+S (Mac), gib einen Namen ein und klicke auf Speichern dies zu tun.
