Documentazione esterna.

G.D.5
Salve a tutti.

Trattasi in questo topic di una consulenza lampo, basta un "Sì" o un "No" come risposta, tanto è banale la domanda.

Devo presentare la documentazione esterna relativa ad un programma che deve essere organizzato in un programma chiamante e una subroutine.

La documentazione esterna è da ritenersi relativa alla sola subroutine o anche al programma chiamante? Preciso che nel programma chiamante le istruzioni da eseguire sono solamente tre: lettura del file con i dati di input, chiamata della subroutine (con relativo scambio I/O di dati) e stampa dei risultati (su terminale o su file).

Grazie.

Risposte
apatriarca
Immagino tu debba farlo su entrambi.. Ma credo sia meglio porre questa domanda a chi ti ha dato da fare questo progetto.

G.D.5
Un caloroso saluti ad entrambi.

Ringrazio anzitutto per le risposte e concordo con entrambi sulla necessità di presentare la documentazione esterna anche per il programma chiamante.

Il motivo per cui non ho fatto la domanda a chi ha assegnato il compito è che questa documentazione esterna è relativa ad un compito assegnato non a me ma ad uno dei ragazzi che seguo nelle mie ripetizioni di Matematica: fa l'ITIS e mi ha chiesto una mano per questo compito, che di Matematica esattamente non è. Siamo giunti alla fine dell'anno e non conoscendo nessuno del settore cui affidarlo non me la sono sentita di liquidarlo, sicché mi sono offerto di dargli un'occhiata. La documentazione l'ha fatta tutta da solo ma non ci ha messo quella sul programma chiamante. Gli ho chiesto perché e se non fosse il caso di metterla e non mi ha saputo dare una risposta convincente, sicché ho pensato di rivolgermi a voi.

apatriarca
Se il compito è suo, fagli prendere le sue decisioni. Ma ha senza dubbio più senso documentare tutto. La documentazione non è mai troppa.

G.D.5
Beh certamente: diciamo che la mia è più una pura curiosità "accademica". Glielo chiesto e non mi ha saputo rispondere, ergo la domanda rigirata.

Rispondi
Per rispondere a questa discussione devi prima effettuare il login.