[każdy język]Doxygen - wprowadzenie

Tutaj umieszczamy tematy związane z językami programowania niepasującymi do innych działów.
Regulamin forum
Temat prosimy poprzedzić nazwą języka umieszczonego w nawiasach kwadratowych np. [Pascal].
Awatar użytkownika
dambo
Expert
Expert
Posty: 613
Rejestracja: czwartek 17 mar 2016, 17:12

[każdy język]Doxygen - wprowadzenie

Postautor: dambo » niedziela 02 kwie 2017, 22:49

Doxygen – do czego on służy – jest to program, który na odstawie naszego kodu źródłowego wygeneruje nam dokumentację biblioteki/projektu. Oczywiście nie jest tak, że zrobi to z niczego – komentarze musimy pisać w specjalny sposób/korzystając ze specjalnej składni. Informacje na ten temat można znaleźć np. tu: https://www.stack.nl/~dimitri/doxygen/m ... locks.html

Wygenerowana dokumentacja może być w formie dokumentu HTML, lub LATEXA. HTML jest o tyle fajny, ze można to sobie wrzucić na stonkę (lub na gita – to też przedstawię) i będzie dostępna online. Tutaj moja pierwsza taka dokumentacja (obecnie w wersji beta :p ) https://dambo1993.github.io/universal_l ... index.html
Więc każdy może wejść i zobaczyć, czy taka forma dokumentacji mu odpowiada.

Generalnie doxygena trzeba pobrać i wygenerowanie takiej dokumentacji zajmuje trochę klikania… lub jak ktoś jest leniwy – można wgrać plugin do środowisk opartych na Eclipse i mieć to mega ładnie wbudowane. Ten plugin nosi nazwę Eclox – pobieramy go z Eclipse marketu:
1.png

Wgrywamy i po restarcie mamy dodatkowa ikonka:
2.png

Do projektu mozme teraz dodać plik typu Doxygen:
3.png

Klikamy na niego dwukrotnie i zmieniamy ustawienia na takie jakie potrzebujemy (ja zastosowałem jak na screenie):
4.png

Teraz za pomocą nowej ikonki wygenerujmy pliki, pojawią się w scieżce wskazanej w pliku ustawień. Dla htmla otrzymamy folder „html” z plikami w środku, możemy go podejrzeć w przeglądarce/Eclipsie.
Fajną opcją jest, ze Eclipse moz nam tworzyć szablony komentarzy doxygena. Tzn ustawiamy kursor nad funkcję wpisujemy „/**” i wciskamy enter. Utworzy się nagłówek z nazwami zmiennych pobranymi z funkcji niżej, my tylko uzupełniamy co one robią. Niestety domyślnie jest to wyłączone, aby uruchomić robimy tak:
6.png

Ostatnia kwestia – jak to wrzucić na gita. W internecie jest wieeele poradników na ten temat, przerobiłem 3 i nie działało. Każdy kombinuje z gałęziami w projekcie i innymi cudami. Widocznie od niedawna jest prostsza opcja. W głównym katalogu repozytorium musimy mieć katalog „docs”, a w nim pliki wygenerowane z Doxygena (wersja html). Teraz przechodzimy do ustawień gita na stronce i zaznaczamy jak na screenie:
5.png

Na górze pojawi się wtedy nasz adres – musimy do niego dopisać index.html i tam znajduje się dokumentacja. Mega proste :)
Jakieś błędy w opisie/sugestie itp? śmiało pisać!
Nie masz wymaganych uprawnień, aby zobaczyć pliki załączone do tego posta.
Ostatnio zmieniony niedziela 02 kwie 2017, 23:23 przez dambo, łącznie zmieniany 1 raz.
Zapraszam na mojego pseudobloga z projektami itp: http://projektydmb.blogspot.com/

Awatar użytkownika
Antystatyczny
Geek
Geek
Posty: 1105
Rejestracja: czwartek 03 wrz 2015, 22:02

Re: [każdy język]Doxygen - wprowadzenie

Postautor: Antystatyczny » niedziela 02 kwie 2017, 22:55

A ja jeszcze podpowiem, że można również generować pdfy. W przypadku korzystania z sytemu windows należy zainstalować MikTex.
"The true sign of intelligence is not knowledge but imagination" Albert Einstein.

Awatar użytkownika
dambo
Expert
Expert
Posty: 613
Rejestracja: czwartek 17 mar 2016, 17:12

Re: [każdy język]Doxygen - wprowadzenie

Postautor: dambo » niedziela 02 kwie 2017, 22:59

No tak - mamy kod LATEXa więc pdfy oczywiście też możliwe. Co kto potrzebuje :)
Zapraszam na mojego pseudobloga z projektami itp: http://projektydmb.blogspot.com/

Awatar użytkownika
mokrowski
User
User
Posty: 182
Rejestracja: czwartek 08 paź 2015, 20:50
Lokalizacja: Tam gdzie Centymetro

Re: [każdy język]Doxygen - wprowadzenie

Postautor: mokrowski » poniedziałek 03 kwie 2017, 00:19

Po doinstalowaniu graphviz http://www.graphviz.org/ , generuje także diagramy klas dla struktur także.
Na samym dole odnośnik "Click here" https://www.stack.nl/~dimitri/doxygen/m ... grams.html

Tu "przeglądówka" jak to zrobić "na surowo" https://masterravi.wordpress.com/2011/1 ... ncy-graph/
,,Myślenie nie jest łatwe, ale można się do niego przyzwyczaić" - Alan Alexander Milne: Kubuś Puchatek

Awatar użytkownika
inż.wielki
User
User
Posty: 264
Rejestracja: niedziela 20 gru 2015, 23:11

Re: [każdy język]Doxygen - wprowadzenie

Postautor: inż.wielki » poniedziałek 03 kwie 2017, 10:21

Czyli jednak się udało. Polecam bardzo tworzenie diagramów. Może w samym C to nie jest aż tak przydatne, ale w C++ jak najbardziej. Do tego można również stworzyć diagram includów, czyli od razu będzie wiadomo, który plik należy załączyć i co od razu z nim dostajemy w "pakiecie" :) Fajny tutek i dobrze że oprócz samego programowania uczysz się też pisania dokumentacji i korzystania z systemów kontroli wersji.

Pozdrawiam


Wróć do „Inne języki programowania”

Kto jest online

Użytkownicy przeglądający to forum: Obecnie na forum nie ma żadnego zarejestrowanego użytkownika i 1 gość