Oraz na pytania: ...Jak opisałbyś matematykę w komentarzach?
Równanie może być bardziej znaczące w formie matematycznej niż w kodzie. Umiejętność umieszczenia matematyki w komentarzach może poprawić czytelność moich projektów.
W .NET btw.
po prostu korzystać z wielu linii, aby zrobić to w ten sposób:
// 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
Nie wymaga za to w ogóle magia. Czy nie uwielbiasz sztuki ASCII?
W celu uzyskania zwykłych komentarzy zwykle używam składni LaTeXa lub Worda. Ale zazwyczaj Word, ponieważ e. sol. β jest bardziej czytelny niż \beta. Ponieważ moje pliki źródłowe są zwykle Unicode, nie stanowi to problemu. Poza tym nie lubię zbyt wielu aparatów ortodontycznych :-)
Czasami znudziło mi się Javadoc i używanie dużej ilości HTML, aby formuły w Javadoc były ładnie wyświetlane, ale to nie ułatwia czytelności źródła (i wykorzystuje fakt, że Javadoc tylko buduje do HTML, bez szczęścia w .NET tutaj).
bym napisał próbkę PAX jako
// 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
rzadko używać indeksów Unicode, choć nie są one w każdej czcionki, zwłaszcza te nie nadają się do kodu :)
FWIW, β w dzisiejszych czasach jest doskonale w porządku - silnik nazywa się XeTeX i jest dołączony do większości dystrybucji TeX-a (TeX Live, MiKTeX, itp.). – ShreevatsaR
Znam XeTeX, a dla zwykłego tekstu z pewnością można dodać wszystko Twoja czcionka ma do zaoferowania, ale nie wiem dokładnie, w jaki sposób XeTeX obsługuje matematykę ... heck, źródło TeX jest wystarczająco zawiłe, że pierwszy TeX z obsługą Unicode pojawił się w tym tysiącleciu ... mniej więcej dekadę po zdefiniowaniu Unicode. Mimo to matematyka w LaTeX ma zbyt wiele nawiasów klamrowych na mój gust :-). I pamiętaj, że matematyka w LaTeXie była jak tuzin różnych czcionek, z których powstała formuła. Patrząc na to, jak Word robi matematykę, wydaje się, że problemem jest uzyskanie dobrego wyniku matematycznego z czcionki bez kupy przygotowań. – Joey
Y” Wiem, że byłaby to świetna aplikacja do rozszerzalności Visual Studio, którą ScottGu pokazał na ostatnim PDC (gdzie napisał wtyczkę MEF wyświetlającą komentarze w innym stylu).
Możesz napisać swoje matematyczne komentarze za pomocą MathML, a następnie wybić wtyczkę, która analizuje znaczniki i wyświetla je jako prawidłowe równanie.
To raczej komentarz na temat "kule w niebie" niż prawdziwa odpowiedź na twoje pytanie, ale pomyślałem, że opublikuję to, aby skłonić ludzi do myślenia. Może ktoś zrobi to pewnego dnia! :)
Należy pamiętać o tym, jaka jest publiczność. Komentarz musi być znaczący dla Ciebie od teraz i dla twoich obecnych i przyszłych kolegów z drużyny. Dlatego, jeśli notacja matematyczna jest dla was wszystkich doskonale zrozumiała, może to być w porządku; jednak, ponieważ nie mogę wiedzieć, kto będzie czytał ten komentarz, dodałbym tekstowy opis lub opis.
To prawda, ale nawet opisanie czegoś prostego w tekście może stać się bardziej skomplikowane niż potrzebne tylko z powodu tekstu. Widzenie czegoś w normalnej składni matematycznej może dać miłe odczucie metody z jednym widokiem. (I trochę tekstu do wyjaśnienia, jeśli to konieczne) – Bertvan
Tak, zgadzam się. Ale chciałem zwrócić uwagę, że czasami może pomóc mały tekst; zwykle notacja matematyczna lepiej opisać, * jaką funkcję spełnia funkcja, podczas gdy część tekstu może pomóc w wyjaśnieniu * dlaczego * autor wybrał * ten * sposób na zrobienie czegoś takiego. Mimo to, po przeczytaniu kilku innych odpowiedzi, miałem przeczucie, że właśnie opuściłem punkt pytania. Przepraszam. –
Dla mnie najłatwiejszym sposobem zrozumienia złożonego problemu matematycznego jest podłączenie rzeczywistych liczb i śledzenie ich. Czytanie o tym, jak to działa, nie wystarczy, chyba że po prostu przypominam sobie, co robi.
Korzystanie z testów Nunit byłoby idealnym rozwiązaniem, jeśli chodzi o praktyczne przykłady zastosowania złożonego problemu matematycznego. Być może po prostu skorzystaj z komentarzy, aby wskazać, że istnieją testy jednostkowe, przez które mogą przejść i gdzie je znaleźć.
Nawiązując do użytkownika @ pax odpowiedź do wykorzystania ASCII-art/zwykły tekst, aby uczynić swoje równania (+1 przy okazji, pax):
Oto krótka lista skrótów klawiszowych dla znaków związanych z matematyki-:
° (stopni) - ALT + 0176
± (plus/minus) - ALT + 0177
² (kwadrat) - ALT + 0178
ł (kostki) - Alt 0179
ź (1/4) - ALT + 0188
pół (1/2) - ALT + 0189
ľ (3/4) - ALT + 0190
użyć lateksu: jeśli jest to proste, możesz to zobaczyć, a jeśli jest to skomplikowane - wytnij i wklej je w najbliższym oknie wyrazu, większość razy parsuje się poprawnie.
To. Nigdy nie jestem daleko od kompilatora LaTeX i jest to miła, zwięzła składnia, którą można łatwo skompilować w bardzo czytelny sposób. –
To miało być komentarzem postu Matta, ale moja reputacja jest zbyt niska. Zrobiłem coś podobnego w LaTex. Jest to składnik kompilacji Sandcastle, który analizuje LaTeX osadzony w komentarzach XML i tworzy obrazy, które są dodawane z powrotem do dokumentacji. Jest to proste opakowanie wokół mimeTeX. Możesz zobaczyć kod alfa pod adresem: http://github.com/cuda/latex-sandcastle/
to będzie coś do zapamiętania ... miła inicjatywa. Do tego czasu pójdę z rozwiązaniem Pax ... – Bertvan
Aby ułatwić renderowanie ASCII matematycznych fomul, istnieje asciiTeX. asciiTeX akceptuje równania w stylu LaTeXa i wypisuje je w ASCII-art.
Muszę myśleć, że większość matematyki wartej udokumentowania (to jest coś stosunkowo rzadkiego i złożonego) byłoby bólem do reprezentowania w sztuce ASCII. –