Zastanawiam się, co powinna zawierać dokumentacja algorytmu? Nie można znaleźć właściwej wytycznej do naśladowania. Mam na myśli to podsumowanie algorytmu opis algorytmu schematy blokowe pseudo kody przykładowy zestaw danych wejściowych (wiele) dane wyjściowe testy
Wydaje mi się, że nie można napisać specyfikacji oprogramowania w języku angielskim, która jest całkowicie wolna od dwuznaczności, po prostu ze względu na nieformalny charakter języka naturalnego - i dlatego naprawdę jednoznaczna specyfikacja musi zawierać kod napisany w języku określonym...
Zasadniczą częścią Domain Driven Design jest konsekwentne stosowanie wszechobecnego języka w całym systemie - w rozmowach, kodzie, schemacie bazy danych, interfejsie użytkownika, testach itp. Jestem zaangażowany w projekt, w którym istnieje już dobrze ugruntowany język domen, zdefiniowany przez...
Jestem zwolenniczką odpowiednio udokumentowanego kodu i doskonale zdaję sobie sprawę z jego wad . To nie wchodzi w zakres tego pytania. Lubię przestrzegać zasady dodawania komentarzy XML dla każdego członka publicznego, biorąc pod uwagę, jak bardzo lubię IntelliSense w Visual Studio. Jest jednak...
Zamknięte . To pytanie musi być bardziej skoncentrowane . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby skupiało się tylko na jednym problemie, edytując ten post . Zamknięte 5 lat temu . Zespół, w którym...
Tam, gdzie obecnie pracuję, ogólne podejście to: unikaj dokumentacji w jak największym stopniu Dokumentuj tylko, jeśli inny zespół będzie go potrzebował tylko dla wyjaśnienia, nie chodzi mi o dokumentację kodu - chodzi o całą dokumentację związaną z procesem projektowania - jeśli są to schematy...
Obecnie używamy zwinnych metod w moim obecnym projekcie i mamy mnóstwo takich historii: Jako asystent chcę zwrócić klientowi zwrot pieniędzy, aby mógł otrzymać pieniądze na żądanie Jako klient chcę zapłacić za zakup, aby otrzymać przedmiot. Jak dotychczas to zrobiliśmy, wybieramy najważniejsze...
Tworzymy komercyjną bibliotekę i przykłady kodu, które są używane przez zewnętrznych programistów. Mamy (zamkniętą, dostępną dla zarejestrowanych użytkowników) dokumentację, która szczegółowo wyjaśnia, jak korzystać z biblioteki. Wielu programistów jest użytkownikami po raz pierwszy, więc napotyka...
Jestem programistą-amatorem, a wszystkie moje dotychczasowe programy były na tyle proste, że można je udokumentować w kodzie. Podczas czytania kodu było jasne, co robię w takim przypadku (moim standardowym testem było przyjrzenie się kodowi 6 miesięcy później i zrozumienie wszystkiego przy...
Kiedyś byłem fanem wymagania komentarzy XML do dokumentacji. Od tego czasu zmieniłem zdanie z dwóch głównych powodów: Podobnie jak dobry kod, metody powinny być zrozumiałe. W praktyce większość komentarzy XML to bezużyteczny szum, który nie zapewnia żadnej dodatkowej wartości. Wiele razy...
Udokumentowałem swój kod doxygen, ale nie chcę domyślnego kodu HTML, który daje. Wiem, że mogę go dostosować, udostępniając niestandardowe pliki CSS, nagłówki, stopki itp. (Podobnie jak GNOME), a także sposób dodawania do plików wspólnego kodu PHP i polecenia zapisania go jako .php, ale tak...
Jakich informacji spodziewałbyś się zobaczyć w github README? Czy wszystko powinno iść w CZYTELNIKU? to znaczy Wprowadzenie Instalacja Wersje Podręcznik użytkownika Realizacja Testowanie Powiązane zasoby A może powinieneś po prostu umieścić pewne rzeczy w README (wprowadzenie, instalacja,...
Zamknięte . To pytanie musi być bardziej skoncentrowane . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby skupiało się tylko na jednym problemie, edytując ten post . Zamknięte 4 lata temu . Dlaczego nadal...
Jestem jedynym programistą w projekcie, który, jak w przypadku każdego projektu oprogramowania, może być zajęty przez kogoś innego w przyszłości. Powiedzmy, że użyłem wzorca X do implementacji funkcji A. Po opracowaniu i ukończeniu tej funkcji, zdaję sobie sprawę, że mogę zaimplementować tę samą...
To może być głupie pytanie, ale przez jakiś czas było w mojej głowie i nigdzie indziej nie mogę znaleźć porządnej odpowiedzi. Mam nauczyciela, który mówi, że powinniśmy wyraźnie wymienić każdy parametr z opisem, nawet jeśli jest tylko jeden. Prowadzi to do wielu powtórzeń: double MyFunction(const...
Więc naprawiasz błędy, a następnie napotkałeś taki, który mógłby wpłynąć na inne moduły oprogramowania. Twoje dane nie są wystarczające, aby uzasadnić swoje twierdzenie o skutkach poprawki i poproszono Cię o utworzenie dokumentu analizy wpływu. Czy istnieje zdefiniowany proces, w jaki sposób to...
Przyjmuję moją pierwszą aplikację na poziomie korporacyjnym i chcę, aby mój zespół modelował całą aplikację ASP.NET MVC C #, zanim jeszcze wybieramy jeden wiersz kodu. AKTUALIZACJA: To nie była filozoficzna dyskusja na temat tego, kiedy dokumentować / modelować aplikację. Podaj tylko odpowiedzi na...
Chcę napisać Javadoc w SUCHY sposób. Ale dokument wyroczni o Javadoc mówi, że napisz to samo w komentarzu metody przeciążenia. Czy nie mogę uniknąć
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...