Come descriveresti la matematica nei commenti?
https://stackoverflow.com/questions/819300
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianDomanda
Bene, come dice la domanda ...
Un'equazione potrebbe essere più significativa nella sua forma notata dalla matematica di quanto non sia nel codice. Essere in grado di inserire commenti matematici potrebbe migliorare la leggibilità dei miei progetti.
In .NET tra.
Soluzione
Uso solo più righe per farlo in questo modo:
// Work out average as: sum (values)
// --------------
// count (values)
//
// and distance between points as:
// _______________________
// / 2 2
// d = \/ (x1 - x0) + (y1 - y0)
//
// and the following function:
//
// 3 2
// f(x) = ax + bx + cx + d
Nessuna magia richiesta per questo. Non ti piace solo l'arte ASCII?
Altri suggerimenti
Seguendo la risposta di @ pax per usare ascii-art / testo semplice per rendere le tue equazioni (+1 a proposito, pax):
Ecco un breve elenco di tasti di scelta rapida per i personaggi matematici:
° (gradi) - Alt + 0176
± (più / meno) - Alt + 0177
² (quadrato) - Alt + 0178
³ (a cubetti) - Alt + 0179
¼ (1/4) - Alt + 0188
½ (1/2) - Alt + 0189
¾ (3/4) - Alt + 0190
Uso il lattice: se è semplice puoi vederlo comunque, e se è complicato - taglialo e incollalo nella finestra di wordpress più vicina, la maggior parte delle volte analizza correttamente.
Per semplici commenti di solito ricorro alla sintassi di LaTeX o Word. Ma di solito Word, poiché e. & Nbsp; g. ß è più leggibile di \ beta . Dato che i miei file sorgente sono in genere Unicode, questo non rappresenta un problema. Inoltre non mi piacciono troppe parentesi graffe intorno a tutto :-)
A volte mi sono annoiato con Javadoc e ho usato molto HTML per far sì che le formule in Javadoc venissero mostrate in modo carino ma ciò non aiuta la leggibilità della fonte (e sfrutta il fatto che Javadoc solo costruisce in HTML, senza fortuna in .NET qui).
Avrei scritto l'esempio di Pax come
// Work out average as:
// ∑(values)/|values|
// and distance between points as:
// d = √( (x_1 - x_0)² + (y_1 - y_0)² )
// and the following function:
// f(x) = ax³ + bx² + cx + d
Raramente uso sottoscrizioni Unicode, dato che non sono presenti in tutti i tipi di carattere, specialmente quelli non adatti al codice :)
Sai, questa sarebbe un'ottima applicazione per l'estensibilità di Visual Studio che ScottGu ha mostrato all'ultimo PDC (dove ha scritto un plug-in MEF per visualizzare i commenti in uno stile diverso).
Puoi scrivere i tuoi commenti matematici usando MathML , quindi chiudere un plug-in che analizza il markup e lo visualizza come un'equazione corretta.
Questo è più un commento "in-the-sky" che una vera risposta alla tua domanda, ma ho pensato di pubblicarlo per far riflettere la gente. Forse qualcuno lo farà un giorno! :)
Questo doveva essere un commento al post di Matt, ma la mia reputazione è troppo bassa. Ho fatto qualcosa di simile per LaTex. È un componente di build Sandcastle che analizza LaTeX incorporato nei commenti XML e crea immagini che vengono aggiunte alla documentazione. È un semplice wrapper per mimeTeX. Puoi vedere il codice alfa all'indirizzo: http://github.com/cuda/latex-sandcastle/
Per me, il modo più semplice per comprendere un problema matematico complesso è collegare alcuni numeri reali e seguirlo. Leggere su come funziona non è sufficiente se non sto semplicemente ricordando a me stesso cosa fa.
L'uso dei test Nunit sarebbe l'ideale per fornire esempi pratici sull'utilizzo del complesso problema matematico. Forse basta usare i commenti per sottolineare che ci sono test unitari che possono superare e dove trovarli.
Per rendere un po 'più semplice il rendering ASCII delle fomule matematiche c'è asciiTeX . asciiTeX accetta equazioni in stile LaTeX e le stampa in ASCII-art.
Ricorda qual è il tuo pubblico. Il commento deve essere significativo per te tra mesi e adesso e per i tuoi compagni di squadra (presenti e futuri). Pertanto, se la notazione matematica è perfettamente comprensibile per tutti voi, questo potrebbe andare bene; tuttavia, poiché non posso sapere chi leggerà quel commento, aggiungerei una rappresentazione o una descrizione testuale.
