Convenzioni adottate nel prototipo MOMIS

• Convenzioni prototipo MOMIS
• Convenzioni Java
• Convenzioni CORBA
• Convenzioni Documentazione
• Convenzioni Tesi
• Suggerimenti vari

Convenzioni sul prototipo MOMIS

• Direttorio di sviluppo su sparc20: /export/home/progetti.comuni/Momis/prototypeNew
• Direttorio pagine web su sparc20: /export/home/httpd/htdocs/Momis/prototipo
• Per velocizzare l'accesso ai direttori di sviluppo si consiglia di aggiungere le seguenti righe al proprio .cshrc:

       #
       # momis environment
       setenv dmt "/export/home/progetti.comuni/Momis/prototypeNew"
       setenv dwp "/export/home/httpd/htdocs/Momis/prototipo"   

  Per saltare alla dir di sviluppo sarà sufficiente scrivere: cd $djp
• Per settare l'ambiente di sviluppo di MOMIS occorre eseguire il comando:

  source $dmt/0setVars

  In $djp vi è lo script 0setVars che aggiorna le variabili di sistema in particolare aggiorna la variabile CLASSPATH.

Convenzioni in Java

• Aggiungere piu` commenti possibili,
  per una dettagliata documentazione sui tag da usare, vedere la documentazione del tool di documentazione javadoc dalla pagina dei manuali
• I nomi delle classi devono iniziare con una lettera Maiuscola
• I nomi dei metodi devono iniziare con una lettera minuscola
• Cercare di NON UTILIZZARE attributi (variabili) pubbliche.
• I nomi degli attributi privati devono iniziare con il carattere "_"
  es: String _nome;

• definizione dei costruttori (constructors)
• metodi privati della classe (Instance protected Methods)
• metodi pubblici della classe (Instance Methods)
• metodi statici della classe (tra cui il main, normalmente usato per testare l'oggetto)
• variabili della private della classe (Instance variables)
• variabili statiche pubbliche, sono le costanti

i blocchi sopa indicati, devono essere racchiusi tra commenti del tipo:

  /**
   * @name Constructors.
   */
  //@{

   ..codice..

  //@}

Tali commenti NON hanno alcun significato per il tool di documentazione javadoc, ma sono riconosciuti da altri tool (quali doc++) e, sopratutto, consentono di dividere e organizzare logicamente il programma in modo che risulti decisamente piu' ordinato e quindi intelleggibile.

Convenzioni in CORBA

• Aggiungere più commenti possibili alle interfacce (vedere il codice idl già prodotto)
• I nomi delle classi devono iniziare con una lettera Maiuscola (come in Java)
  Per la sintassi CORBA-IDL vedere dalla pagina http://sparc20.ing.unimo.it/documenti/omg/index.html la specifica completa e in particolare Chapter 3-IDL Syntax and Semantics
• I nomi dei metodi devono iniziare con una lettera minuscola
• Cercare di NON UTILIZZARE attributi (variabili) pubbliche.

Convenzioni sulla Documentazione On-line

• Direttorio pagine web su sparc20: /export/home/httpd/htdocs/Momis/prototipo
• Mantenere allinate il piú possibile le pagine web del prototipo con il codice che si sta producendo.
• Le pagine web indice devono essere scritte in HTML
• Nei link utilizzare riferimenti relativi e MAI assoluti, se la pagina corrente ha indirizzo

  http://sparc20.ing.unimo.it/Momis/prototipo

  per indirizzare la pagina scrivere nel link

  nuova/pagina.html

  invece di

  http://sparc20.ing.unimo.it/Momis/prototipo/nuova/pagina.html

  questo permette di muovere i documenti tra le dir senza dover cambiare tutti i link!
• La documentazione derivata da documenti latex (come la tesi) è bene sia dispobibile in formato pdf (non ps o dvi o latex). A tal proposito su sparc20 esiste il comando dvipdf oppure ps2pdf.

Convenzioni sulla Tesi

• Vedere la pagina delle disposizioni generiche /tesi/disposizioni.html
• Nelle tesi e nella documentazione on-line, predisporre una sezione in cui si spiega (con buon livello di dettaglio) gli sviluppi futuri per l'applicazione e le parti non sviluppate. Occorre descrivere per quale motivo tali parti non sono state sviluppate, eventuali scelte compiute per aggirare il problema e dare il maggior numero di informazioni possibili per permettere in futuro a qualcun altro di affrontare e risolvere il problema.

Suggerimenti vari

• Su sparc20 esiste l'utility

  java2html

  che, dato un programma Java (funziona anche con l'IDL) produce automaticamente una pagina HTML con le istruzioni colorate. Provare per credere.

• Uso di xv
  xv e' un programma che permette la cattura delle immagini in modo relativamente semplice.Per utilizzarlo:
  • Lanciare xv da riga di comando
  • Premere il pulsante destro del mouse per far apparire il menu
  • Per la cattura di immagini dal desktop premere "Grab"
  • Impostare un ritardo (in secondi e diverso da 0) dopo il quale la finestra selezionata viene catturata.
  • Tramite il pulsante "Save" e' possibile salvare l'immagine in qualunque formato.