Linee guida sul codice
Da Dreamos Wiki Page.
n questa pagina troverete le informazioni utili per scrivere codice per dreamOS.
I file sorgenti
Per i file sorgenti e' preferibile attenersi alle seguenti indicazioni:
- File con un numero di righe non troppo alto (max poche centinaia)
- I sorgenti devono essere sempre suddivisi ove possobile nel suo file header (.h) e file sorgente (.c)
- Cercare di commentare il piu possibile mentre si scrive.
La documentazione
La documentazione si snoda su piu fronti:
- Direttamente nel codice con i commenti (possibilmente in formato doxygen, in modo da creare una documentazione delle varie librerie dell'os)
- Con i file README, principalmente sull'utilizzo di script e ausili per la compilazione
- Nel dreamos system programming, un documento PDF che sara' la guida all'utilizzo e allo sviluppo di dreamos.
Quindi quando si programma in dreamos cercare sempre di documentare le funzioni, le strutture dati, secondo la sintassi doxygen. Se si aggiungono nuove feature a qualche script di compilazione, o si aggiunge qualche nuovo script, aggiornare (o crearne uno nuovo se necessario) il README.
