Related changes
Enter a page name to see changes on pages linked to or from that page. (To see members of a category, enter Category:Name of category). Changes to pages on your Watchlist are in bold.
List of abbreviations:
- N
- This edit created a new page (also see list of new pages)
- m
- This is a minor edit
- b
- This edit was performed by a bot
- (±123)
- The page size changed by this number of bytes
16 May 2024
|
12:05 | Doxygen/pl 27 changes history +779 [Kaktus (27×)] | |||
|
12:05 (cur | prev) +26 Kaktus talk contribs (Created page with "Zobacz tę odpowiedź w [https://stackoverflow.com/a/35377654 Stackoverflow], aby zapoznać się z innymi alternatywami dla dokumentowania kodu C++ i Python razem w tym samym projekcie.") | ||||
|
12:05 (cur | prev) +20 Kaktus talk contribs (Created page with "Aby dowiedzieć się więcej o tym procesie, zobacz [https://breathe.readthedocs.io/en/latest/quickstart.html Skróconą instrukcję obsługi] w dokumentacji Breathe.") | ||||
|
12:04 (cur | prev) +75 Kaktus talk contribs (Created page with "Podczas gdy Sphinx może natywnie analizować dokumentację Python, analizowanie źródeł C++ wymaga nieco więcej pracy. Projekt [https://breathe.readthedocs.io/en/latest/ Breathe] ([https://github.com/michaeljones/breathe Github]) jest próbą wypełnienia luki między Sphinx i Doxygen, w celu zintegrowania zarówno dokumentacji kodu źródłowego Python, jak i C++ w tym samym systemie. Po pierwsze, Doxygen musi być skonfigurowany do wyprowadzania pliku XML. Dane wyj...") | ||||
|
12:03 (cur | prev) +41 Kaktus talk contribs (Created page with "[https://www.sphinx-doc.org/en/master/ Sphinx] jest najpopularniejszym systemem do dokumentowania kodu źródłowego Pythona. Ponieważ jednak podstawowe funkcje i środowiska pracy FreeCAD są napisane w języku C++, uznano, że Doxygen jest lepszym narzędziem dokumentacyjnym dla tego projektu.") | ||||
|
12:03 (cur | prev) +60 Kaktus talk contribs (Created page with "==Dokumentacja źródłowa z użyciem Sphinx==") | ||||
|
12:02 (cur | prev) +30 Kaktus talk contribs (Created page with "Dobrym pomysłem jest również zweryfikowanie jakości kodu Python za pomocą narzędzia takiego jak [http://flake8.pycqa.org/en/latest/ flake8] ([https://gitlab.com/pycqa/flake8 Gitlab]). Flake8 łączy przede wszystkim trzy narzędzia, [https://github.com/PyCQA/pyflakes Pyflakes], [https://github.com/PyCQA/pycodestyle Pycodestyle] ''(dawniej pep8)'' i [https://github.com/PyCQA/mccabe McCabe complexity checker], w celu wymuszenia właściwego stylu kodu Python.") | ||||
|
12:01 (cur | prev) +21 Kaktus talk contribs (Created page with "Zawsze używaj potrójnych cudzysłowów dla docstrings i upewnij się, że następują one bezpośrednio po deklaracji klasy lub funkcji.") | ||||
|
12:00 (cur | prev) +3 Kaktus talk contribs (Created page with "<div class="mw-collapsible mw-collapsed toccolours"> Następujące style komentowania nie pozwolą na analizowanie docstringów przez {{incode|doxypy}}, więc należy ich unikać.") | ||||
|
12:00 (cur | prev) +27 Kaktus talk contribs (Created page with "Aby skorzystać z automatycznej konwersji bloków dokumentacji, ważne jest, aby oryginalne źródła Python były poprawnie napisane, zgodnie z wytycznymi Python zawartymi w [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8] i [https://www.python.org/dev/peps/pep-0257/ PEP257]. Niechlujnie napisany kod spowoduje, że {{incode|doxypypy}} zawiedzie podczas przetwarzania pliku, a tym samym Doxygen nie będzie w stanie poprawnie sformatować dokumentacji.") | ||||
|
11:58 (cur | prev) +47 Kaktus talk contribs (Created page with "===Kontrola jakości kodu Python===") | ||||
|
11:57 (cur | prev) +29 Kaktus talk contribs (Created page with "{{Caption|Ogólny przepływ pracy do tworzenia dokumentacji kodu źródłowego za pomocą Doxygen, gdy pliki Python są filtrowane w celu przekształcenia bloków komentarzy.}}") | ||||
|
11:56 (cur | prev) +20 Kaktus talk contribs (Created page with "Zauważ, że istniejące pliki Python, które już używają stylu {{incode|##double hash}} dla swoich bloków komentarzy, nie zostaną dotknięte przez filtr {{incode|doxypypy}} i będą normalnie przetwarzane przez Doxygen.") | ||||
|
11:56 (cur | prev) +110 Kaktus talk contribs (Created page with "Po wykonaniu tej konfiguracji można uruchomić komendę {{incode|doxygen Doxyfile}} w celu wygenerowania dokumentacji w standardowy sposób. Każdy plik Python korzystający z <code><nowiki>'''potrójnych cudzysłowów'''</nowiki></code> w Pythonie zostanie na bieżąco przeformatowany, aby używać komentarzy w stylu {{incode|##Doxygen}}, a następnie zostanie przetworzony przez Doxygen, który teraz będzie mógł interpretować #Znaczniki_Doxygen|specjalne poleceni...") | ||||
|
11:43 (cur | prev) +9 Kaktus talk contribs (Created page with "W systemach Windows plik wsadowy może być używany w podobny sposób.") | ||||
|
11:43 (cur | prev) +9 Kaktus talk contribs (Created page with "Po zapisaniu tego skryptu powłoki, upewnij się, że ma on uprawnienia do wykonywania i że znajduje się w katalogu zawartym w twoim systemie {{incode|PATH}}.") | ||||
|
11:42 (cur | prev) +6 Kaktus talk contribs (Created page with "Program {{incode|doxypypy_filter}} nie istnieje domyślnie; powinien zostać utworzony jako skrypt powłoki uruchamiający {{incode|doxypypy}} z odpowiednimi opcjami i przyjmujący plik jako pierwszy argument.") | ||||
|
11:42 (cur | prev) +29 Kaktus talk contribs (Created page with "Powoduje to, że pliki pasujące do wzorca, wszystkie pliki z rozszerzeniem kończącym się na {{incode|.py}}, będą przechodzić przez program {{incode|doxypypy_filter}}. Za każdym razem, gdy Doxygen napotka taki plik w drzewie źródłowym, nazwa pliku zostanie przekazana jako pierwszy argument do tego programu.") | ||||
|
11:42 (cur | prev) +31 Kaktus talk contribs (Created page with "Aby rozpocząć, nie używaj bezpośrednio programu {{incode|doxypy}}. Zamiast tego utwórz plik konfiguracyjny za pomocą {{incode|doxygen -g}}, a następnie edytuj utworzony {{incode|Doxyfile}} i zmodyfikuj następujący znacznik.") | ||||
|
11:41 (cur | prev) +24 Kaktus talk contribs (Created page with "W poprzednim przykładzie konwersja bloków dokumentacji została wykonana ręcznie tylko z jednym plikiem źródłowym. Idealnie chcielibyśmy, aby ta konwersja następowała automatycznie, w locie, z dowolną liczbą plików Python. Aby to zrobić, należy odpowiednio edytować konfigurację Doxygen.") | ||||
|
11:40 (cur | prev) +56 Kaktus talk contribs (Created page with "===Konwertowanie stylu komentarzy w locie===") | ||||
|
11:39 (cur | prev) +1 Kaktus talk contribs (Created page with "Dokumentacja powinna zawierać informacje podobne do poniższych i zawierać odpowiednie linki do poszczególnych modułów.") | ||||
|
11:18 (cur | prev) −6 Kaktus talk contribs (Created page with "Aby skompilować, utwórz konfigurację i uruchom {{incode|doxygen}} w katalogu toplevel zawierającym pliki.") | ||||
|
11:18 (cur | prev) +10 Kaktus talk contribs (Created page with "<div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} ''(góra jest edytowana ręcznie, reszta pozostaje bez zmian)''") | ||||
|
11:18 (cur | prev) +54 Kaktus talk contribs (Created page with "W nowym pliku styl komentowania został zmieniony, więc linia staje się {{incode|##@package pyexample_pythonic}}, która teraz będzie interpretowana przez Doxygen. Aby jednak argument został poprawnie zinterpretowany, musi zostać ręcznie edytowany, aby pasował do nowej nazwy modułu (pliku); po wykonaniu tej czynności linia powinna mieć postać {{incode|##@package pyexample_doxygen}}.") | ||||
|
11:17 (cur | prev) +21 Kaktus talk contribs (Created page with "Oryginalny plik posiada komentarz na górze <code><nowiki>'''@package pyexample_pythonic</nowiki></code>, który wskazuje moduł lub przestrzeń nazw opisywaną przez plik. To słowo kluczowe {{incode|@package}} nie jest interpretowane podczas używania potrójnych cudzysłowów w bloku komentarza.") | ||||
|
11:16 (cur | prev) +20 Kaktus talk contribs (Created page with "Gdy program {{incode|doxypy}} jest zainstalowany i dostępny z terminala, plik Python z Pythonowymi docstringami może zostać przeformatowany na styl Doxygen za pomocą poniższych instrukcji. Program wypisuje przeformatowany kod na standardowe wyjście, więc należy przekierować to wyjście do nowego pliku.") | ||||
|
11:15 (cur | prev) +6 Kaktus talk contribs (Created page with "Alternatywnie, można utworzyć dowiązanie symboliczne do programu {{incode|doxypy}}, umieszczając dowiązanie w katalogu, który jest już zawarty w {{incode|PATH}}.") |