Tool per inserire equazioni nei commenti del software

[dimaios]

Ho trovato una applicazione a mio avviso molto utile che risolve un problema ricorrente ..... scrivere le equazioni nel commento del codice.

Infatti, per documentare i calcoli risulta piuttosto scomodo fornire un documento separato perche' il programmatore mediamente si riferisce sempre al sorgente.

A questo proposito ho cercato un'applicazione che traducesse in "ASCII Art" le equazioni ed ho trovato questo

http://sourceforge.net/projects/asciitex/?source=dlp

E' fatto piuttosto bene e l'ho trovato utile perche' converte il LaTex in ASCII Art e quindi con un semplice Cut & Paste si inserisce la formula nel codice sorgente favorendo il debug e le modifiche da parte del programmatore.

Veramente un bel lavoro da parte dell'autore.

A me e' piaciuto molto e spero sia utile anche a voi.

[carlomariamanenti]

Bello e utile, grazie dimaios!

[dimaios]

[DirtyDeeds]

Un'altra possibilità, un po' più complessa però, è quella di commentare il codice secondo il formato Doxygen, scrivendo le formule in LaTeX, e usando Doxygen per generare la documentazione in LaTeX o in HTML.

[xyz]

Io uso Doxygen per documentare il codice, ha il supporto per le formule in LaTex. Nei sorgenti rimangono in LaTex ma poi quando si genera la documentazione in HTML, PDF, LaTex, ecc... sono rese nel miglior modo possibile in base al formato d'uscita.

http://www.stack.nl/~dimitri/doxygen/ma ... mulas.html

[dimaios]

Doxygen è sicuramente un tool molto potente ma l'idea di scrivere un commento con la formula seppure in formato ASCII art like mi sembra immediato e utile ... e perché no...anche bello da vedere.

[spud]

L'ho provato e mi è venuta una domandina, se ad esempio la formula è composta da più righe, per inserirla nel codice copi una riga alla volta e poi le allinei a mano?

[dimaios]

Dipende dall' editor che utilizzi.
In certi e' permesso fare cut & past di aree qualsiasi quindi copi ed incolli direttamente nell'area del sorgente ove vuoi inserire la formula in "ASCII art".

[Ianero]

Molto bello e utile, grazie

[xyz]

...poi le allinei a mano?

Per queste cose c'è il magico comando di riformattazione "par":

http://www.nicemice.net/par/

credo che non sia semplice capire le sue opzioni ma è molto potente e fa risparmiare tantissimo tempo.