Zasada DRY (Don't Repeat Yourself) mówi, że „każda wiedza musi mieć jedną, jednoznaczną, autorytatywną reprezentację w systemie”. Najczęściej odnosi się to do kodu, ale często obejmuje również dokumentację. Mówi się, że każdy system oprogramowania ma architekturę, niezależnie od tego, czy ją...
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 . celem jest posiadanie...
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 . Zawsze zastanawiałem...
Po wielu poszukiwaniach nie udało mi się odpowiedzieć na podstawowe pytanie dotyczące założonego znanego w świecie twórców oprogramowania: CO JEST ZNANE: Egzekwowanie ścisłej polityki dotyczącej odpowiedniej dokumentacji kodu (czy to znaczników Doxygen, Javadoc, czy po prostu mnóstwa komentarzy)...
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 2 lata temu . Czy ktoś kiedykolwiek...
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 . Ostatnio czytałem kilka...
Chcę poprawić swoje umiejętności programistyczne, studiując znane projekty open source, ale łatwo się zgubić, po prostu wskakując do ich kodu źródłowego. Postanowiłem więc przeczytać ich dokumentację dotyczącą ich projektu lub architektury (np. Diagramów UML), aby najpierw uzyskać ogólne...
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 . Ukończyłem aplikację...
Moim zdaniem same przypadki testów jednostkowych służą jako dokumentacja kodu. Moja firma chce, żebym napisał szczegółowe komentarze w dokumentacji Java na górnej części przypadków testów jednostkowych. Czy to konieczne? Czy piszesz takie
Czasami jest 1% kodu, który jest wystarczająco intensywny obliczeniowo, co wymaga najcięższego rodzaju optymalizacji niskiego poziomu. Przykładami są przetwarzanie wideo, przetwarzanie obrazu i ogólnie wszelkiego rodzaju przetwarzanie sygnału. Celem jest udokumentowanie i nauczenie technik...
Mam projekt na uniwersytet, o którym nie zacznę od razu, ale zastanawiam się nad nim dość długo. Rozumiem, że rozwój projektu uniwersyteckiego nie jest jak przemysł (obecnie sam jestem stażystą), więc sytuacja, którą w tej chwili wskażę, będzie prawdopodobnie wydawać się absurdalna dla prawdziwych...
Kiedy piszę dla siebie małe skrypty, układam swój kod wysoko w stos z komentarzami (czasami komentuję więcej niż koduję). Wiele osób, z którymi rozmawiam, mówi, że powinienem dokumentować te skrypty, nawet jeśli są one osobiste, więc jeśli kiedykolwiek je sprzedam, będę gotowy. Ale czy komentarze...
Czy są jakieś powszechne praktyki komentowania wyrażeń regularnych: komentarze wstawiane odnoszące się do innej części RegEx lub komentarze ogólne dla wszystkich
Zamknięte. To pytanie jest nie na temat . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby było tematem dotyczącym wymiany stosów inżynierii oprogramowania. Zamknięte 6 lat temu . Jestem zwolennikiem komentowania...
Obecnie pracuję nad ukończeniem studiów na kierunku „Tworzenie oprogramowania”, w których muszę indywidualnie opracowywać złożone oprogramowanie w firmie zewnętrznej. Wszystko to należy wykonać w sposób ustrukturyzowany, tworząc wszystkie odpowiednie dokumenty. W tym projekcie postanowiłem...
Nasze oprogramowanie ma kilka klas, które należy dynamicznie znaleźć poprzez odbicie. Wszystkie klasy mają konstruktor z określoną sygnaturą, za pośrednictwem której kod odbicia tworzy instancję obiektów. Jednak gdy ktoś sprawdzi, czy metoda jest przywołana (na przykład za pomocą soczewki Visual...
Trudno powiedzieć, o co tu pytają. To pytanie jest dwuznaczne, niejasne, niepełne, zbyt szerokie lub retoryczne i na obecną formę nie można w rozsądny sposób odpowiedzieć. Aby uzyskać pomoc w wyjaśnieniu tego pytania, aby można je było ponownie otworzyć, odwiedź centrum pomocy ....
Jestem jednym z tych programistów, którzy myślą, że napisany kod powinien być zrozumiały i czytać jak książkę. JEDNAK, opracowując kod biblioteki dla innych osób, staram się umieszczać jak najwięcej dokumentacji w plikach nagłówków; co rodzi pytanie: czy warto udokumentować metody niepubliczne?...
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...
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...