L’intestazione di un programma

Dopo che ci si è un po’ esercitati con qualche istruzione e qualche programma che la contiene, è indispensabile dare qualche nozione di standard.

Il nome di un programma deve essere standard ossia deciso per tipologia o obiettivo. Ad esempio, se si sta sviluppando una serie di programmi per un’azienda con nome COC tutti i programmi cominceranno con queste tre lettere poi dei numeri progressivi; oppure se si sono create delle funzioni la quarta lettera può essere una F per indicare funzione o una P, per indicare un programma nel caso precedente.

Ad esempio, ho creato una funzione; il nome del relativo file che la conterrà avrà il nome:

COCF0001

Se invece il file è un programma esso si chiamerà COCP0001.

Nel caso di esercizi di sviluppo, come all’inizio di un corso, si potranno chiamare ESP00001 o ESP00002, dove con ES indico esercizio, P come programma e 00001 è un progressivo. Notare che usare nomi brevi permette al computer di identificare e utilizzare i programmi il meglio possibile ed al programmatore un accesso molto veloce e di facile scrittura.

Una volta salvati i file in una cartella ricordarsi SEMPRE di creare un indice con all’interno i nomi di tutti i file della cartella ed una spiegazione di cosa fanno.

Tale convenzione è fondamentale quando si cominciano ad avere molti file o programmi, all’inizio sembra una cosa noiosa perchè ci si ricorda esattamente cosa fanno ma vi assicuro che dopo un po’ di tempo è indispensabile.

Un’altra regola FONDAMENTALE è inserire all’inizio del programma le seguenti righe:

#######################################################
# Python 3.2.2
# Autore: Francesco Bragadin
# Data creazione: 4/1/2012
# Ultima modifica: 4/1/2012
#
# Nome file: ESP00001.py
#
# Commenti:
#          Verifica di programmazione
#          esercizio 1:
#          numero intero successivo a quello dato
#####################################################################

Come si nota se in ogni programma si usa questa intestazione appena lo si apre si intuisce cosa fa, da chi è stato scritto quando si è creato, e quando è stato modificato l’ultima volta.

E’ fondamentale farlo per tutti i programmi.

Questa voce è stata pubblicata in Uncategorized. Contrassegna il permalink.

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *