Qual è la migliore piattaforma per spiegare lo pseudo-codice a uno sviluppatore che non ne sa nulla? [chiuso]

metti il codice MATLAB in ms-word; cambia il carattere in corriere (monospazio) se aiuta

evidenzia ogni riga e usa Inserisci commento (nella scheda Revisione in parola 2010) per inserire la tua spiegazione

lo sviluppatore può fare lo stesso; la parola farà diverse caselle di commento per ognuno di voi

Assumerò un programmatore che ha già familiarità con Matlab. Meno dolore per tutti. Ci sono molti ex matematici che lavorano nello sviluppo di software: -)

lavagna!

La sintassi di MATLAB è piuttosto lontana rispetto a un linguaggio procedurale "normale" (~ = per non eguaglia !!!!?), quindi documentare ogni riga di codice probabilmente non sarà di grande aiuto (una linea la trasformazione della matrice in MATLAB spesso tradurrà a poche centinaia di righe di codice C, ad esempio).

Perché non passare un po 'di tempo a esaminare la funzionalità del programma con lo sviluppatore di fronte a una lavagna con un laptop con (o la stampa di) il codice a portata di mano. In questo modo puoi rimanere bloccato nei bit di difficile comprensione del programma stesso, non nella sintassi MATLAB.

Se ti stai solo aspettando che traducano in una lingua diversa, non vuoi che conoscano i dettagli di come MATLAB esegue comunque la sua elaborazione, probabilmente non si tradurrà molto bene in altre lingue , MATLAB è molto specializzato per lavorare con le matrici. In realtà hai solo bisogno che sappiano che devi moltiplicare la matrice A per prodotto B e fare X con l'output.

Che ne dici di utilizzare strumenti di revisione del codice come Rietveld o ReviewBoard

Puoi aggiungere commenti e discussioni che non fanno parte del codice Matlab stesso.

Sono una persona scientifica che ha bisogno di documentare codice Matlab complesso da consegnare a uno sviluppatore perché lo capisca e programma in una lingua diversa. In passato, ho usato MS Word (spiegando ogni passo del programma come una nuova riga in una tabella), e poi Excel, ma non ho trovato particolarmente adatto per visualizzare il mio codice Matlab e inserire commenti in modo chiaro e conciso modo per documentarlo.

Bene, Word potrebbe funzionare ... credo. Si definiscono stili diversi per parti diverse del codice (commenti in verde, codice in ...). Non sono sicuro se quanto è pratico in realtà. Cosa c'è di sbagliato con solo esportarlo come HTML e servire lo sviluppatore in questione che. Può sempre usare l'aiuto online, se c'è un problema, se non ha già installato MATLAB.

Dopo aver letto alcuni commenti, vorrei provare a spiegare di più ... Presumo che tutti gli sviluppatori conoscano lo pseudo-codice, ma non presumo che molti conoscano il codice Matlab. Quindi, se scrivo in pseudo-codice, posso ignorare il codice Matlab (o fornirlo come riferimento, ecc.).

Dato che stai traducendo il codice MATLAB e dici che sei una persona scientifica, puoi presumere che le equazioni matematiche potrebbero essere un'alternativa praticabile.

Attenzione però ... a volte le funzioni MATLAB utilizzate NON sono quelle descritte nella guida. Metti alla prova il tuo nuovo codice lungo la strada.