Programerus - 12-04-2012, 23:27 Temat postu: Dokumentacja Skończyłem tłumaczenie kodu (40 godzin mi to zajęło, a jeszcze CBot.dll został). Rozpocząłem dokumentowanie kodu. Wszystko znajdziecie tutaj: Link W związku z tym mam kilka ogłoszeń duszpasterskich: 1.Szukam osoby chętnej na przetłumaczenie dokumentacji na angielski, ew. inne języki. 2.Szukam osoby, która uzupełniłaby luki, ew. opisała w lepszy sposób to co już do tej pory napisałem. 3.Szukam pomysłów, co musi się znaleźć w takiej dokumentacji. 4.Szukam pomocnika do pisania dokumentacji. Wszystkich chętnych prosiłbym o zgłaszanie się w tym temacie, bądź na PW. krzys_h - 13-04-2012, 12:30 Zgłaszam się do punktu 2 i jak będzie trzeba to może do 4 [ Dodano: 13-04-2012, 12:31 ] PS. Gratuluję cierpliwości w tłumaczeniu piotrdz - 13-04-2012, 19:26 Jak już piszemy dokumentację, to może warto skorzystać z Doxygena i dodać od razu komentarze w kodzie. Wtedy wszystko będzie w jednym miejscu. Poza tym, Doxygen generuje automatycznie diagramy klas i wywołań funkcji, więc może się przydać do lepszego zrozumienia kodu. lukas_j - 14-04-2012, 15:12 No no, gratulacje. Jak widać prace, mimo ze powoli, to jednak posuwają się do przodu 
matusz - 14-04-2012, 20:44 spróbuję potłumaczyć na angielski pozostałe punkty - w miarę możliwości mógłbyś bywać na IRCu czasem? piotrdz - 16-04-2012, 21:06 Stanęło na razie na tym, że dokumentacja będzie pisana w Doxygenie. W repozytorium jest teraz wstawiony plik Doxyfile i można sobie wygenerować dokumentację w HTML. Do repozytorium nie będziemy wstawiać tej wygenerowanej dokumentacji, bo cała idea jest taka, że dokumentacja jest w kodzie, w komentarzach, a jak ktoś chce ją obejrzeć w HTML'u to odpala Doxygena u siebie. W przyszłości można pomyśleć o generowaniu automatycznie co ileś commitów takiej dokumentacji i umieszczeniu jej na jakiejś stronie. Dokumentacja, jak mówiłem będzie głównie w plikach z kodem - na stronie Doxygena jest opisane jak umieszczać znaczniki Doxygena. Generalnie dokumentować można każdą klasę, strukturę, funkcję, i pole klasy. Póki co można zacząć od opisu ważniejszych klas. W repo dodałem też plik docmain.doc.txt z tym opisem plików, który był w PDF - pojawia się teraz na głównej stronie dokumentacji. Myślę, że właśnie takie osobne pliki można dodać dla takich ogólnych dokumentów - rozszerzenie .doc.txt to dla odróżnienia od pozostałych .txt w repo. Update: Jakby ktoś zabierał się za dokumentację (a przydało by się), to może zobaczyć na wzór jak to ma wyglądać, moje nowe moduły src/math w gałęzi dev. |
