Questo articolo spiega come creare un documento pseudocodice per il tuo programma per computer. Lo pseudocodice implica essenzialmente la creazione di una struttura in linguaggio non di programmazione dell'intento del codice.
Passi
Parte 1 di 3: Comprensione delle basi dello pseudocodice
Passaggio 1. Sapere cos'è lo pseudocodice
Lo pseudocodice è una struttura scritta passo passo del tuo codice che puoi trascrivere gradualmente nel linguaggio di programmazione. Molti programmatori lo usano per pianificare la funzione di un algoritmo prima di dedicarsi al compito più tecnico della codifica.
Lo pseudocodice funge da guida informale, uno strumento per pensare ai problemi del programma e un'opzione di comunicazione che può aiutarti a spiegare le tue idee ad altre persone.
Passaggio 2. Comprendi perché lo pseudocodice è utile
Lo pseudocodice viene utilizzato per mostrare come dovrebbe funzionare un algoritmo di calcolo. I programmatori usano spesso lo pseudocodice come passaggio intermedio nella programmazione tra la fase di pianificazione iniziale e la fase di scrittura del codice eseguibile effettivo. Alcuni altri usi dello pseudocodice includono quanto segue:
- Descrivere come dovrebbe funzionare un algoritmo. Lo pseudocodice può illustrare dove un particolare costrutto, meccanismo o tecnica può o deve apparire in un programma.
- Spiegare un processo informatico agli utenti meno tecnici. I computer hanno bisogno di una sintassi di input molto rigida per eseguire un programma, ma gli esseri umani (specialmente i non programmatori) possono trovare più facile capire un linguaggio più fluido e soggettivo che affermi chiaramente lo scopo di ogni riga di codice.
- Progettazione del codice in un contesto di gruppo. Gli architetti di software di alto livello spesso includono pseudocodice nei loro progetti per aiutare a risolvere un problema complesso in cui vedono i loro programmatori imbattersi. Se stai sviluppando un programma insieme ad altri programmatori, potresti scoprire che lo pseudocodice aiuta a chiarire le tue intenzioni.
Passaggio 3. Ricorda che lo pseudocodice è soggettivo e non standard
Non c'è una sintassi fissa che devi assolutamente usare per lo pseudocodice, ma è una cortesia professionale comune usare strutture di pseudocodice standard che altri programmatori possono facilmente capire. Se stai codificando un progetto da solo, la cosa più importante è che lo pseudocodice ti aiuti a strutturare i tuoi pensieri e ad attuare il tuo piano.
- Se stai lavorando con altri su un progetto, che siano tuoi colleghi, programmatori junior o collaboratori non tecnici, è importante utilizzare almeno alcune strutture standard in modo che tutti gli altri possano facilmente comprendere il tuo intento.
- Se sei iscritto a un corso di programmazione presso un'università, un campo di codifica o un'azienda, probabilmente verrai testato contro uno "standard" di pseudocodice insegnato. Questo standard varia spesso tra le istituzioni e gli insegnanti.
La chiarezza è un obiettivo primario dello pseudocodice e può essere utile se si lavora all'interno delle convenzioni di programmazione accettate. Man mano che sviluppi il tuo pseudocodice in codice effettivo, dovrai trascriverlo in un linguaggio di programmazione, in modo che possa aiutarti a strutturare il tuo schema tenendo conto di ciò.
Passaggio 4. Concentrati sullo scopo principale dello pseudocodice
Può essere facile tornare a scrivere nel codice una volta che hai fatto il passo. Ricordare lo scopo del tuo pseudocodice - spiegare cosa dovrebbe fare ogni riga del programma - ti terrà con i piedi per terra durante la creazione del documento pseudocodice.
Parte 2 di 3: scrivere un buon pseudocodice
Passaggio 1. Utilizzare un editor di testo normale
Si può essere tentati di utilizzare un elaboratore di testi (ad es. Microsoft Word) o un programma simile per creare un documento RTF, ma lo pseudocodice richiede la minima formattazione possibile per renderlo semplice.
Gli editor di testo normale includono Blocco note (Windows) e TextEdit (Mac).
Passaggio 2. Inizia scrivendo lo scopo del processo
Dedicare una o due righe alla spiegazione dello scopo del tuo codice ti aiuterà a impostare il resto del documento e ti risparmierà anche il compito di spiegare la funzione del programma a ogni persona a cui mostri lo pseudocodice.
Passaggio 3. Scrivi solo un'istruzione per riga
Ogni istruzione nel tuo pseudocodice dovrebbe esprimere solo un'azione per il computer. Nella maggior parte dei casi, se l'elenco delle attività è disegnato correttamente, ogni attività corrisponderà a una riga di pseudocodice. Prendi in considerazione la possibilità di scrivere la tua lista di attività, quindi tradurre quella lista in pseudocodice, quindi sviluppare gradualmente quello pseudocodice in codice reale leggibile dal computer.
Passaggio 4. Utilizzare lo spazio bianco e il rientro in modo efficace
L'uso di spazi bianchi tra i "blocchi" di testo aiuterà a mantenere isolati i diversi componenti del tuo pseudocodice e l'indentazione di diversi pezzi di ciascun blocco indicherà che quei pezzi di pseudocodice vanno in una sezione meno rientrata.
Ad esempio, una sezione di pseudocodice che discute l'immissione di un numero dovrebbe essere tutta nello stesso "blocco", mentre la sezione successiva (ad esempio, la sezione che discute l'output) dovrebbe trovarsi in un blocco diverso
Passaggio 5. Se necessario, capitalizzare i comandi chiave
A seconda dei requisiti dello pseudocodice o dell'ambiente in cui pubblichi lo pseudocodice, potrebbe essere necessario scrivere in maiuscolo i comandi che rimarranno nel codice effettivo.
Ad esempio, se usi i comandi "if" e "then" nel tuo pseudocodice, potresti volerli modificare per leggere "IF" e "THEN" (ad es., "IF numero di input THEN risultato di output")
Passaggio 6. Scrivi usando una terminologia semplice
Ricorda, stai scrivendo su cosa farà il progetto, non riassumendo il codice stesso. Questo è particolarmente importante se stai scrivendo uno pseudocodice che serva come dimostrazione per un cliente che non conosce la codifica o come progetto per un programmatore principiante.
Potresti anche voler eliminare del tutto qualsiasi comando di codifica e definire semplicemente il processo di ogni riga in un linguaggio semplice. Ad esempio, "se l'input è dispari, l'output 'Y'" potrebbe diventare "se l'utente immette un numero dispari, visualizza invece 'Y'".
Passaggio 7. Mantieni il tuo pseudocodice nell'ordine corretto
Mentre il linguaggio che usi per modificare il tuo pseudocodice dovrebbe essere semplice, devi comunque mantenere ogni parte del tuo pseudocodice nell'ordine in cui deve essere eseguito.
Passaggio 8. Non lasciare nulla all'immaginazione
Tutto ciò che sta accadendo nel processo deve essere descritto completamente. Le istruzioni pseudocodice sono vicine alle semplici istruzioni in inglese. Lo pseudocodice in genere non utilizza variabili, ma descrive invece cosa dovrebbe fare il programma con oggetti vicini al mondo reale come numeri di conto, nomi o importi delle transazioni.
Passaggio 9. Utilizzare strutture di programmazione standard
Anche se non esiste uno standard per lo pseudocodice, sarà più facile per gli altri programmatori comprendere i tuoi passaggi se utilizzi strutture di linguaggi di programmazione (sequenziali) esistenti. Usa termini come "if", "then", "while", "else" e "loop" nello stesso modo in cui faresti nel tuo linguaggio di programmazione preferito. Considera le seguenti strutture:
- if CONDITION then ISTRUZIONI - Ciò significa che una data istruzione verrà eseguita solo se una data condizione è vera. "Istruzione", in questo caso, indica un passaggio che il programma eseguirà, mentre "condizione" significa che i dati devono soddisfare un determinato insieme di criteri prima che il programma agisca.
- while CONDITION do INSTRUCTION - Ciò significa che l'istruzione deve essere ripetuta ancora e ancora fino a quando la condizione non è più vera.
- fare ISTRUZIONI mentre CONDIZIONE - Questo è molto simile a "mentre CONDIZIONE fai ISTRUZIONI". Nel primo caso, la condizione viene verificata prima dell'esecuzione dell'istruzione, ma nel secondo caso l'istruzione verrà eseguita per prima; quindi, nel secondo caso, l'ISTRUZIONE sarà svolta almeno una volta.
- funzione NOME (ARGOMENTI): ISTRUZIONI - Ciò significa che ogni volta che un determinato nome viene utilizzato nel codice, è l'abbreviazione di una determinata istruzione. Gli "argomenti" sono elenchi di variabili che è possibile utilizzare per chiarire l'istruzione.
Passaggio 10. Organizza le tue sezioni di pseudocodice
Se hai grandi sezioni di pseudocodice che definiscono altre parti di pseudocodice all'interno dello stesso blocco, potresti voler usare parentesi o altri identificatori per mantenere tutto contenuto.
- Le parentesi, sia standard (ad es. [code]) che curve (ad es. {code}), possono aiutare a contenere lunghi segmenti di pseudocodice.
-
Durante la codifica, puoi aggiungere commenti digitando "" sul lato sinistro del commento (ad es.
//Questo è un passaggio temporaneo.
- ). Puoi usare questo stesso metodo quando scrivi pseudocodice per lasciare note che non si adattano al testo di codifica.
Passaggio 11. Ricontrolla il tuo pseudocodice per leggibilità e chiarezza
Dovresti essere in grado di rispondere alle seguenti domande entro la fine del documento:
- Questo pseudocodice sarebbe compreso da qualcuno che non ha familiarità con il processo?
- Lo pseudocodice è scritto in modo tale che sia facile tradurlo in un linguaggio informatico?
- Lo pseudocodice descrive il processo completo senza tralasciare nulla?
- Ogni nome di oggetto utilizzato nello pseudocodice è chiaramente compreso dal pubblico di destinazione?
- Se trovi che una sezione di pseudocodice necessita di elaborazione o non delinea esplicitamente un passaggio che qualcun altro potrebbe dimenticare, torna indietro e aggiungi le informazioni necessarie.
Parte 3 di 3: creazione di un documento di pseudocodice di esempio
Passaggio 1. Aprire un editor di testo normale
Puoi utilizzare Blocco note (Windows) o TextEdit (Mac) per impostazione predefinita se non desideri installare un nuovo programma.
Passaggio 2. Definisci il tuo programma
Sebbene non sia strettamente necessario, scrivere una riga di una o due frasi all'inizio del documento chiarirà fin dall'inizio l'intento del programma:
Questo programma richiederà un saluto dall'utente. Se il saluto corrisponde a una risposta specifica, la risposta verrà consegnata; in caso contrario, verrà consegnato un rifiuto.
Passaggio 3. Scrivi la sequenza di apertura
Il tuo primo comando, ovvero la prima cosa che il tuo programma dovrebbe fare durante l'esecuzione, dovrebbe essere la prima riga:
stampa saluto "Ciao straniero!"
Passaggio 4. Aggiungi la riga successiva
Inserisci uno spazio tra l'ultima riga e la successiva premendo Invio, quindi crea la riga di codice successiva. In questo esempio, l'utente dovrebbe richiedere la riga di dialogo successiva:
richiesta di stampa premere "Invio" per continuare
Passaggio 5. Aggiungi l'invito all'azione
In questo esempio, all'utente verrà richiesto un saluto:
stampa invito all'azione "Come stai?"
Passaggio 6. Mostra all'utente un elenco di risposte
Ancora una volta, dopo aver premuto Invio in questo esempio, l'utente dovrebbe vedere un elenco di possibili risposte:
visualizzare le possibili risposte "1. Bene." "2. Fantastico!" "3. Non va bene."
Passaggio 7. Richiedere l'input dall'utente
Qui è dove il programma chiederà all'utente di inserire una risposta:
stampa richiesta di input "Inserisci il numero che meglio ti descrive:"
Passaggio 8. Creare comandi "if" per l'input dell'utente
Poiché ci sono più risposte che l'utente può selezionare, ti consigliamo di aggiungere più risultati in base alla risposta selezionata:
se "1" stampa la risposta "Dandy!" se "2" print response "Fantastico!" se "3" print response "Alleggerisci, ranuncolo!"
Passaggio 9. Aggiungi un messaggio di errore
Nel caso in cui l'utente scelga erroneamente una risposta, puoi avere pronto un messaggio di errore:
se l'input non viene riconosciuto print response "Non segui molto bene le istruzioni, vero?"
Passaggio 10. Aggiungi qualsiasi altro componente del programma
Esamina il documento e aggiungi o arricchisci i dettagli per assicurarti che sia tu che chiunque legga il documento ne capirete il significato. Come per l'esempio di questo metodo, il tuo documento pseudocodice finale dovrebbe assomigliare a questo:
Questo programma richiederà un saluto dall'utente. Se il saluto corrisponde a una risposta specifica, la risposta verrà consegnata; in caso contrario, verrà consegnato un rifiuto. stampa saluto "Ciao straniero!" richiesta di stampa premere "Invio" per continuare
stampa invito all'azione "Come stai oggi?" visualizzare le possibili risposte "1. Bene." "2. Fantastico!" "3. Non va bene." print request for input "Inserisci il numero che meglio ti descrive:" if "1" print response "Dandy!" se "2" print response "Fantastico!" se "3" print response "Alleggerisci, ranuncolo!" se l'input non viene riconosciuto print response "Non segui molto bene le istruzioni, vero?"
Passaggio 11. Salva il tuo documento
Premi Ctrl+S (Windows) o Command+S (Mac), inserisci un nome e fai clic su Salva fare così.
