Ta wikiHow uczy, jak stworzyć dokument z pseudokodem dla twojego programu komputerowego. Pseudokod zasadniczo pociąga za sobą stworzenie zarysu intencji kodu, który nie jest językiem programowania.
Kroki
Część 1 z 3: Zrozumienie podstaw pseudokodu
Krok 1. Dowiedz się, czym jest pseudokod
Pseudokod to napisany krok po kroku zarys Twojego kodu, który możesz stopniowo transkrybować na język programowania. Wielu programistów używa go do planowania funkcji algorytmu przed podjęciem bardziej technicznego zadania kodowania.
Pseudokod służy jako nieformalny przewodnik, narzędzie do rozwiązywania problemów z programem oraz opcja komunikacji, która może pomóc w wyjaśnieniu swoich pomysłów innym osobom.
Krok 2. Zrozum, dlaczego pseudokod jest przydatny
Pseudokod służy do pokazania, jak powinien działać algorytm obliczeniowy. Koderzy często używają pseudokodu jako etapu pośredniego w programowaniu pomiędzy początkowym etapem planowania a etapem pisania rzeczywistego kodu wykonywalnego. Niektóre inne zastosowania pseudokodu obejmują:
- Opisywanie, jak powinien działać algorytm. Pseudokod może ilustrować, gdzie konkretna konstrukcja, mechanizm lub technika może lub musi pojawić się w programie.
- Wyjaśnianie procesu obliczeniowego użytkownikom mniej technicznym. Komputery potrzebują bardzo ścisłej składni wejściowej, aby uruchomić program, ale ludziom (zwłaszcza nie-programistom) może być łatwiej zrozumieć bardziej płynny, subiektywny język, który jasno określa cel każdego wiersza kodu.
- Projektowanie kodu w środowisku grupowym. Architekci oprogramowania wysokiego poziomu często dołączają do swoich projektów pseudokod, aby pomóc rozwiązać złożony problem, na który wpadają ich programiści. Jeśli tworzysz program wraz z innymi programistami, może się okazać, że pseudokod pomaga w jasnych intencjach.
Krok 3. Pamiętaj, że pseudokod jest subiektywny i niestandardowy
Nie ma ustalonej składni, której bezwzględnie musisz używać w przypadku pseudokodu, ale powszechną profesjonalną uprzejmością jest używanie standardowych struktur pseudokodu, które inni programiści mogą łatwo zrozumieć. Jeśli sam kodujesz projekt, najważniejsze jest to, że pseudokod pomaga ci uporządkować myśli i zrealizować plan.
- Jeśli pracujesz z innymi nad projektem - czy są to Twoi koledzy, młodsi programiści, czy nietechniczni współpracownicy - ważne jest, aby użyć przynajmniej niektórych standardowych struktur, aby wszyscy inni mogli łatwo zrozumieć Twoje zamiary.
- Jeśli jesteś zapisany na kurs programowania na uniwersytecie, na obozie kodowania lub w firmie, prawdopodobnie zostaniesz przetestowany pod kątem nauczonego „standardu” pseudokodu. Ten standard często różni się w zależności od instytucji i nauczycieli.
Przejrzystość jest głównym celem pseudokodu i może pomóc, jeśli pracujesz w ramach przyjętych konwencji programowania. Podczas opracowywania pseudokodu w rzeczywisty kod, będziesz musiał dokonać transkrypcji go na język programowania – dzięki czemu może to pomóc w ustrukturyzowaniu konspektu, mając to na uwadze.
Krok 4. Skoncentruj się na głównym celu pseudokodu
Powrót do pisania w kodzie może być łatwy, gdy tylko wykonasz swój krok. Zapamiętanie celu pseudokodu – wyjaśnianie, co każda linia programu powinna zrobić – pozwoli ci zachować rozsądek podczas tworzenia dokumentu pseudokodu.
Część 2 z 3: Pisanie dobrego pseudokodu
Krok 1. Użyj zwykłego edytora tekstu
Użycie procesora tekstu (np. Microsoft Word) lub podobnego programu do stworzenia dokumentu z tekstem sformatowanym może być kuszące, ale pseudokod wymaga jak najmniejszego formatowania, aby był prosty.
Edytory zwykłego tekstu obejmują Notatnik (Windows) i TextEdit (Mac).
Krok 2. Zacznij od spisania celu procesu
Poświęcenie jednej lub dwóch linijek na wyjaśnienie celu twojego kodu pomoże w skonfigurowaniu reszty dokumentu, a także oszczędzi ci zadania wyjaśniania funkcji programu każdej osobie, której pokazujesz pseudokod.
Krok 3. Napisz tylko jedną instrukcję w wierszu
Każda instrukcja w pseudokodzie powinna wyrażać tylko jedną akcję komputera. W większości przypadków, jeśli lista zadań jest poprawnie narysowana, to każdemu zadaniu odpowiada jedna linia pseudokodu. Rozważ napisanie swojej listy zadań, a następnie przetłumaczenie jej na pseudokod, a następnie stopniowe przekształcenie tego pseudokodu w rzeczywisty kod czytelny dla komputera.
Krok 4. Efektywnie wykorzystuj odstępy i wcięcia
Używanie spacji między „blokami” tekstu pomoże w izolacji różnych elementów pseudokodu, a wcięcie różnych fragmentów każdego bloku wskaże, że te fragmenty pseudokodu znajdują się w mniej wciętej sekcji.
Na przykład sekcja pseudokodu, która omawia wprowadzanie liczby, powinna znajdować się w tym samym „bloku”, podczas gdy następna sekcja (np. sekcja omawiająca dane wyjściowe) powinna znajdować się w innym bloku
Krok 5. W razie potrzeby pisz komendy klawiszowe wielką literą
W zależności od wymagań dotyczących pseudokodu lub środowiska, w którym publikujesz pseudokod, może być konieczne zapisanie poleceń wielkimi literami, które pozostaną w rzeczywistym kodzie.
Na przykład, jeśli używasz poleceń „if” i „then” w swoim pseudokodzie, możesz chcieć je zmienić na „IF” i „THEN” (np. „IF input number THEN output wynik”)
Krok 6. Pisz używając prostej terminologii
Pamiętaj, piszesz o tym, co zrobi projekt, a nie podsumowujesz sam kod. Jest to szczególnie ważne, jeśli piszesz pseudokod, który ma służyć jako demonstracja dla klienta, który nie zna się na kodowaniu, lub jako projekt dla początkującego programisty.
Możesz nawet całkowicie pozbyć się wszelkich poleceń kodujących i po prostu zdefiniować proces każdej linii w prostym języku. Na przykład „jeśli dane wejściowe są nieparzyste, dane wyjściowe „T” może zmienić się w „jeśli użytkownik wprowadzi nieparzystą liczbę, zamiast tego wyświetl „T”.
Krok 7. Zachowaj swój pseudokod we właściwej kolejności
Chociaż język, którego używasz do modyfikowania pseudokodu, powinien być prosty, nadal musisz zachować każdy fragment pseudokodu w kolejności, w jakiej ma być wykonywany.
Krok 8. Nie zostawiaj niczego wyobraźni
Wszystko, co dzieje się w tym procesie, musi być dokładnie opisane. Wyrażenia pseudokodowe są zbliżone do prostych instrukcji angielskich. Pseudokod zazwyczaj nie używa zmiennych, ale zamiast tego opisuje, co program powinien zrobić z obiektami zbliżonymi do rzeczywistych, takimi jak numery kont, nazwy lub kwoty transakcji.
Krok 9. Użyj standardowych struktur programistycznych
Nawet jeśli nie ma standardu pseudokodu, innym programistom łatwiej będzie zrozumieć twoje kroki, jeśli użyjesz struktur z istniejących (sekwencyjnych) języków programowania. Używaj terminów takich jak "if", "then", "while", "else" i "loop" w taki sam sposób, jak w preferowanym języku programowania. Rozważ następujące struktury:
- if CONDITION then INSTRUCTION - Oznacza to, że dana instrukcja zostanie wykonana tylko wtedy, gdy dany warunek jest spełniony. „Instrukcja” w tym przypadku oznacza krok, który program wykona, natomiast „warunek” oznacza, że dane muszą spełniać określony zestaw kryteriów, zanim program podejmie działanie.
- while CONDITION do INSTRUCTION - Oznacza to, że instrukcja powinna być powtarzana raz za razem, aż warunek przestanie być spełniony.
- wykonaj INSTRUCTION while CONDITION - Jest to bardzo podobne do "gdy CONDITION wykonaj INSTRUCTION". W pierwszym przypadku warunek sprawdzany jest przed realizacją dyspozycji, natomiast w drugim przypadku dyspozycja zostanie zrealizowana jako pierwsza; zatem w drugim przypadku INSTRUKCJA zostanie przeprowadzona co najmniej jeden raz.
- NAZWA funkcji (ARGUMENTY): INSTRUKCJA - Oznacza to, że każdorazowe użycie w kodzie określonej nazwy jest skrótem od określonej instrukcji. „Argumenty” to listy zmiennych, których można użyć do wyjaśnienia instrukcji.
Krok 10. Uporządkuj sekcje pseudokodu
Jeśli masz duże sekcje pseudokodu, które definiują inne fragmenty pseudokodu w tym samym bloku, możesz użyć nawiasów lub innych identyfikatorów, aby zachować wszystko zawarte.
- Nawiasy - zarówno standardowe (np. [code]), jak i zakrzywione (np. {code}) - mogą pomóc w zmieszczeniu długich segmentów pseudokodu.
-
Podczas kodowania możesz dodawać komentarze, wpisując „” po lewej stronie komentarza (np.
//To jest tymczasowy krok.
- ). Możesz użyć tej samej metody podczas pisania pseudokodu, aby pozostawić notatki, które nie pasują do tekstu kodu.
Krok 11. Dokładnie sprawdź swój pseudokod pod kątem czytelności i przejrzystości
Powinieneś być w stanie odpowiedzieć na następujące pytania pod koniec dokumentu:
- Czy ten pseudokod byłby zrozumiały dla kogoś, kto nie jest zaznajomiony z tym procesem?
- Czy pseudokod jest napisany w taki sposób, aby można go było łatwo przetłumaczyć na język komputerowy?
- Czy pseudokod opisuje cały proces bez pomijania czegokolwiek?
- Czy każda nazwa obiektu użyta w pseudokodzie jest zrozumiała dla odbiorców docelowych?
- Jeśli okaże się, że sekcja pseudokodu wymaga dopracowania lub nie określa wyraźnie kroku, o którym ktoś inny może zapomnieć, wróć i dodaj niezbędne informacje.
Część 3 z 3: Tworzenie przykładowego dokumentu pseudokodowego
Krok 1. Otwórz edytor zwykłego tekstu
Możesz użyć Notatnika (Windows) lub TextEdit (Mac) domyślnie, jeśli nie chcesz instalować nowego programu.
Krok 2. Zdefiniuj swój program
Chociaż nie jest to bezwzględnie konieczne, napisanie jedno- lub dwuzdaniowej linii na górze dokumentu od samego początku wyjaśni intencje programu:
Ten program poprosi użytkownika o powitanie. Jeśli powitanie pasuje do określonej odpowiedzi, odpowiedź zostanie dostarczona; jeśli nie, zostanie dostarczone odrzucenie.
Krok 3. Napisz sekwencję otwierania
Twoje pierwsze polecenie, czyli pierwszą rzeczą, jaką twój program powinien zrobić po uruchomieniu, powinno być pierwszym wierszem:
drukuj powitanie "Witaj nieznajomy!"
Krok 4. Dodaj następną linię
Umieść spację między ostatnim wierszem a następnym, naciskając ↵ Enter, a następnie utwórz kolejny wiersz kodu. W tym przykładzie użytkownik powinien podpowiedzieć następną linię dialogu:
monit drukowania naciśnij „Enter”, aby kontynuować
Krok 5. Dodaj wezwanie do działania
W tym przykładzie użytkownik zostanie poproszony o powitanie:
drukuj wezwanie do działania „Jak się masz?”
Krok 6. Pokaż użytkownikowi listę odpowiedzi
Ponownie, po naciśnięciu ↵ Enter w tym przykładzie, użytkownik powinien zobaczyć listę możliwych odpowiedzi:
wyświetl możliwe odpowiedzi "1. Dobrze." "2. Świetnie!" „3. Niedobrze”.
Krok 7. Poproś użytkownika o wprowadzenie danych
W tym miejscu program poprosi użytkownika o wprowadzenie odpowiedzi:
żądanie wydruku dla danych wejściowych "Wprowadź numer, który najlepiej Cię opisuje:"
Krok 8. Utwórz polecenia „if” dla danych wejściowych użytkownika
Ponieważ istnieje wiele odpowiedzi, które użytkownik może wybrać, warto dodać wiele wyników na podstawie wybranej odpowiedzi:
jeśli "1" wypisz odpowiedź "Dandy!" jeśli "2" wypisz odpowiedź "Fantastycznie!" jeśli „3” wypisz odpowiedź „Rozjaśnij się, jaskier!”
Krok 9. Dodaj komunikat o błędzie
W przypadku, gdy użytkownik błędnie wybierze odpowiedź, możesz mieć gotowy komunikat o błędzie:
jeśli dane wejściowe nie są rozpoznawane, odpowiedź drukuj „Nie postępujesz zbyt dobrze zgodnie z instrukcjami, prawda?”
Krok 10. Dodaj inne komponenty programu
Przejrzyj swój dokument i dodaj lub uzupełnij wszelkie szczegóły, aby upewnić się, że zarówno Ty, jak i każda osoba czytająca dokument zrozumie jego znaczenie. Zgodnie z przykładem tej metody, ostateczny dokument pseudokodu powinien wyglądać mniej więcej tak:
Ten program poprosi użytkownika o powitanie. Jeśli powitanie pasuje do określonej odpowiedzi, odpowiedź zostanie dostarczona; jeśli nie, zostanie dostarczone odrzucenie. drukuj powitanie "Witaj nieznajomy!" monit drukowania naciśnij "Enter", aby kontynuować
print wezwanie do działania „Jak się masz dzisiaj?” wyświetl możliwe odpowiedzi "1. Dobrze." "2. Świetnie!" „3. Niedobrze”. żądanie wydruku dla danych wejściowych „Wprowadź liczbę, która najlepiej Cię opisuje:” jeśli „1” wydrukuj odpowiedź „Dandy!” jeśli "2" wypisz odpowiedź "Fantastycznie!" jeśli „3” wypisz odpowiedź „Rozjaśnij się, jaskier!” jeśli dane wejściowe nie są rozpoznawane, odpowiedź drukuj „Nie postępujesz zbyt dobrze zgodnie z instrukcjami, prawda?”
Krok 11. Zapisz dokument
Naciśnij Ctrl+S (Windows) lub ⌘ Command+S (Mac), wprowadź nazwę i kliknij Zapisać aby to zrobić.
