Pytania otagowane jako documentation

Dokumentacja oprogramowania jest tekstem towarzyszącym oprogramowaniu komputerowemu. Wyjaśnia, jak działa oprogramowanie, jak go zainstalować, jak go używać i inne zasoby pomocy.

6
Jak udokumentować swój kod w celu sprawdzenia jego minimalnego czasu? [Zamknięte]
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 w zeszłym roku . Chcę udokumentować mój kod w taki sposób, aby minimalne zapotrzebowanie na czytanie i przeglądanie kodu …
8
Czy powinieneś udokumentować wszystko, czy tylko większość?
Trochę kontrowersyjnym tematem wydaje się dokumentowanie wszystkiego, w tym składni geterów i setterów dla pól w języku „JavaBean”: ludzie mówią, że jest to niepotrzebnie długi i powtarzający się DRY (nie powtarzaj się) , że konwencja nazewnictwa powinna wszystko wyjaśniać , i zaśmieca kod / dokumentację. Czasami te argumenty działają. Ale …
6
Czy testy jednostkowe naprawdę są wykorzystywane jako dokumentacja?
Nie mogę policzyć, ile razy czytam stwierdzenia w duchu „testy jednostkowe są bardzo ważnym źródłem dokumentacji testowanego kodu”. Nie przeczę, że są prawdziwe. Ale osobiście nigdy nie używałem ich jako dokumentacji. W typowych ramach, których używam, deklaracje metod dokumentują ich zachowanie i to wszystko, czego potrzebuję. Zakładam, że testy jednostkowe …
5
W jakim czasie gramatycznym powinienem napisać swoje specyfikacje?
Obecnie piszemy specyfikacje funkcjonalne i techniczne w formacie dwóch kolumn; zdanie podsumowujące i szczegóły techniczne. Szczegóły często odnoszą się do dodatku zawierającego diagramy, projekty układów itp. Walczę jednak z tym, w jakim czasie napisać to: Z czasem przeszłym, jakby praca była wykonywana, staram się pokazywać rozszerzenia najważniejszych zakończeń pracy. Czas …
4
Jak udokumentować strukturę wysokiego poziomu programu Java?
Kontekst: Ja i moi współpracownicy piszemy artykuł do czasopisma akademickiego. W trakcie naszych badań napisaliśmy program symulacyjny w Javie. Chcemy, aby program symulacji był swobodnie dostępny dla innych. Zdecydowaliśmy się na hosting kodu w repozytorium GitHub. Aby ułatwić innym korzystanie, chcemy napisać dobrą dokumentację dla naszego programu, w tym: Javadocs …
1
Czy powielanie dokumentacji dotyczącej implementacji / zastąpień interfejsu jest dobre czy złe?
Mamy więc taki interfejs /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Niedawno odtworzyliśmy historię dokumentacji, która polegała na wygenerowaniu i …
6
Stary programista zniknął. O zatrudnienie innego programisty. Jak do tego podejść? [Zamknięte]
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć faktami i cytatami, edytując ten post . Zamknięte 6 lat temu . Po ponad roku pracy nad projektem sieci społecznościowej dla mnie przy użyciu WordPress …
4
Dokumentowanie logiki matematycznej w kodzie
Czasami, choć nie często, muszę zawrzeć logikę matematyczną w kodzie. Stosowane pojęcia są w większości bardzo proste, ale wynikowy kod nie jest - wiele zmiennych o niejasnym celu i niektóre operacje o mniej oczywistych zamiarach. Nie oznacza to, że kod jest nieczytelny lub unmaintainable, tylko że to waaaay trudniejszy do …
6
Kod samodokumentujący vs Javadocs?
Ostatnio pracuję nad refaktoryzacją części bazy kodu, z którą obecnie mam do czynienia - nie tylko po to, aby lepiej ją zrozumieć, ale także aby ułatwić innym, którzy pracują nad kodem. Zwykle opieram się na myśleniu, że samodokumentujący się kod jest fajny . Po prostu uważam, że jest czystszy i …
11
Co powinieneś zostawić swoim następcom?
Załóżmy, że jesteś jedynym programistą, który opuszcza pracę. Jakiego rodzaju informacje / materiały poza samym kodem powinieneś stworzyć i zostawić do wymiany? Oczywistą odpowiedzią jest na pewno „cokolwiek byś chciał w nowej pracy”, ale minęło trochę czasu, odkąd zacząłem nową pracę i zapominam, jakie były najważniejsze rzeczy, których wtedy potrzebowałem. …
6
Czy konieczne jest napisanie komentarza javadoc do KAŻDEGO parametru w sygnaturze metody?
Jeden z deweloperów w moim zespole uważa, że ​​konieczne jest napisanie komentarza javadoc do KAŻDEGO parametru w sygnaturze metody. Nie sądzę, aby było to konieczne, a nawet uważam, że może być szkodliwe. Po pierwsze, uważam, że nazwy parametrów powinny być opisowe i samodokumentujące. Jeśli nie jest od razu oczywiste, do …
2
Jaki standard zastąpił 830-1998?
Zastanawiałem się, jak formalnie dokumentować projekty oprogramowania i dowiedziałem się o IEEE 830-1998: Zalecana praktyka dotycząca specyfikacji wymagań oprogramowania . Jednak, jak widać z tego linku, został on zastąpiony. Wiem, że 830-1998, a prawdopodobnie nawet 830-1993, są prawdopodobnie odpowiednie do użycia. Jeśli jednak nic innego nie chciałbym wiedzieć, który standard …
5
Jak określa się minimalne wymagania systemowe?
Wszyscy widzieliśmy niezliczone przykłady oprogramowania dostarczanego z „minimalnymi wymaganiami systemowymi”, takie jak: Windows XP / Vista / 7 1 GB pamięci RAM 200 MB pamięci Jak są one ogólnie określone? Oczywiście czasami występują określone ograniczenia (jeśli program zajmuje 200 MB na dysku, jest to trudne wymaganie). Oprócz tych sytuacji, wiele …
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.