Jeśli mam fragment kodu, który jest matematycznie lub strukturalnie dość złożony i nieredukowalnie, to jak miałbym udokumentować ten fragment kodu? W szczególności, w jaki sposób mogę zapewnić, że ktoś, kto może nie mieć umiejętności matematycznych lub architektonicznych, które rozumiem, może to...
(Przypadkowo) badałem podejścia oparte na semantyce / ontologii do dokumentacji technicznej, kiedy natknąłem się na ten klejnot : Programowanie piśmienne i sieć semantyczna to pomysły z różnych czasów, które mają związek. Dokument połączony, Literate Programming in XML autorstwa Normana...
Po pierwsze, zdaję sobie sprawę, że to pytanie może być nieco długie i niejasne i przepraszam za to. Jest to prawdopodobnie podstawowy problem z krótką nazwą dla każdego, kto go „rozumie”, ale ponieważ brakuje mi w tym względzie, proszę o wyrozumiałość przy opisywaniu problemu. Programowałem w ten...
Chcę zobaczyć, jak robią to inni ludzie. Zwłaszcza w sytuacjach, gdy wielu różnych klientów korzysta z tej samej bazy oprogramowania z nieco innymi regułami biznesowymi. Jakich praktyk używasz do dokumentowania, jak wszystko ma działać, czy reguł biznesowych. Zasadniczo więc, gdy nowy programista...
Mam zamiar opuścić projekt i zanim odejdę, mój szef poprosił mnie o udokumentowanie kodu (nie udokumentowałem zbyt dobrze). To nie jest wielka sprawa, projekt nie jest strasznie skomplikowany. Ale w mojej dokumentacji znajduję miejsca, w których chciałbym powiedzieć: „Zawiadomienie w linii XYZ, że...
Odnosi się to do dyskusji w odpowiedzi i komentarzy do tego pytania: Co jest związane z awersją do dokumentacji w branży? . W odpowiedzi twierdzono, że „kod nie może kłamać”, a zatem powinna być lokalizacją docelową zamiast dokumentacji. Kilka komentarzy wskazuje, że „kod może kłamać”. Po obu...
Przeglądając implementację funkcji innego programisty w celu obliczenia CDF o rozkładzie normalnym , zasugerowałem, aby albo zastąpić całą implementację wbudowanymi funkcjami Pythona, albo użyć SciPy, wspólnej biblioteki naukowej. Inny programista zauważył, że ani math.erfc()nie...
Pracuję nad małą biblioteką, która zapewnia implementacje podstawowych, dobrze znanych metryk ciągu. Głównie dla mojej własnej edukacji. Rozwój odbywa się za każdym razem, gdy mam trochę wolnego czasu. Z tego powodu zautomatyzowałem większość procesów, dzięki czemu mogę wypuszczać wersję tak...
Często rozwiązuję błędy, znajdując odpowiedź na temat Przepełnienia stosu. Czy złym zwyczajem jest dodawanie fragmentu, dlaczego zrobiłem to, co zrobiłem, a następnie dodawanie łącza do artykułu lub strony z