Doxygen/pl: Revision history

Diff selection: Mark the radio buttons of the revisions to compare and hit enter or the button at the bottom.
Legend: (cur) = difference with latest revision, (prev) = difference with preceding revision, m = minor edit.

(newest | oldest) View (newer 50 | ) (20 | 50 | 100 | 250 | 500)

16 May 2024

  • curprev 12:0512:05, 16 May 2024Kaktus talk contribs 44,773 bytes +26 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."
  • curprev 12:0512:05, 16 May 2024Kaktus talk contribs 44,747 bytes +20 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."
  • curprev 12:0412:04, 16 May 2024Kaktus talk contribs 44,727 bytes +75 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..."
  • curprev 12:0312:03, 16 May 2024Kaktus talk contribs 44,652 bytes +41 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."
  • curprev 12:0312:03, 16 May 2024Kaktus talk contribs 44,611 bytes +60 Created page with "==Dokumentacja źródłowa z użyciem Sphinx=="
  • curprev 12:0212:02, 16 May 2024Kaktus talk contribs 44,551 bytes +30 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."
  • curprev 12:0112:01, 16 May 2024Kaktus talk contribs 44,521 bytes +21 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."
  • curprev 12:0012:00, 16 May 2024Kaktus talk contribs 44,500 bytes +3 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ć."
  • curprev 12:0012:00, 16 May 2024Kaktus talk contribs 44,497 bytes +27 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."
  • curprev 11:5811:58, 16 May 2024Kaktus talk contribs 44,470 bytes +47 Created page with "===Kontrola jakości kodu Python==="
  • curprev 11:5711:57, 16 May 2024Kaktus talk contribs 44,423 bytes +29 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.}}"
  • curprev 11:5611:56, 16 May 2024Kaktus talk contribs 44,394 bytes +20 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."
  • curprev 11:5611:56, 16 May 2024Kaktus talk contribs 44,374 bytes +110 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..."
  • curprev 11:4311:43, 16 May 2024Kaktus talk contribs 44,264 bytes +9 Created page with "W systemach Windows plik wsadowy może być używany w podobny sposób."
  • curprev 11:4311:43, 16 May 2024Kaktus talk contribs 44,255 bytes +9 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}}."
  • curprev 11:4211:42, 16 May 2024Kaktus talk contribs 44,246 bytes +6 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."
  • curprev 11:4211:42, 16 May 2024Kaktus talk contribs 44,240 bytes +29 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."
  • curprev 11:4211:42, 16 May 2024Kaktus talk contribs 44,211 bytes +31 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."
  • curprev 11:4111:41, 16 May 2024Kaktus talk contribs 44,180 bytes +24 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."
  • curprev 11:4011:40, 16 May 2024Kaktus talk contribs 44,156 bytes +56 Created page with "===Konwertowanie stylu komentarzy w locie==="
  • curprev 11:3911:39, 16 May 2024Kaktus talk contribs 44,100 bytes +1 Created page with "Dokumentacja powinna zawierać informacje podobne do poniższych i zawierać odpowiednie linki do poszczególnych modułów."
  • curprev 11:1811:18, 16 May 2024Kaktus talk contribs 44,099 bytes −6 Created page with "Aby skompilować, utwórz konfigurację i uruchom {{incode|doxygen}} w katalogu toplevel zawierającym pliki."
  • curprev 11:1811:18, 16 May 2024Kaktus talk contribs 44,105 bytes +10 Created page with "<div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} ''(góra jest edytowana ręcznie, reszta pozostaje bez zmian)''"
  • curprev 11:1811:18, 16 May 2024Kaktus talk contribs 44,095 bytes +54 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}}."
  • curprev 11:1711:17, 16 May 2024Kaktus talk contribs 44,041 bytes +21 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."
  • curprev 11:1611:16, 16 May 2024Kaktus talk contribs 44,020 bytes +20 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."
  • curprev 11:1511:15, 16 May 2024Kaktus talk contribs 44,000 bytes +6 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}}."

14 May 2024

  • curprev 11:1211:12, 14 May 2024Kaktus talk contribs 43,994 bytes +62 Created page with "Jeśli polecenie {{incode|pip}} zostanie użyte bez opcji {{incode|--user}}, będzie wymagało uprawnień superużytkownika (root) do zainstalowania pakietu, ale w większości przypadków nie jest to konieczne; używaj uprawnień roota tylko wtedy, gdy masz pewność, że pakiet nie będzie kolidował z pakietami dostarczonymi przez twoją dystrybucję."
  • curprev 11:1211:12, 14 May 2024Kaktus talk contribs 43,932 bytes +9 Created page with "Doxypypy można zainstalować za pomocą {{incode|pip}}, instalatora pakietów Python."
  • curprev 11:1111:11, 14 May 2024Kaktus talk contribs 43,923 bytes +43 Created page with "Poprzedni przykład pokazuje, że plik Python, który jest komentowany w Styl Doxygen pokazuje bardziej szczegółowe informacje i formatowanie dla jego klas, funkcji i zmiennych. Powodem jest to, że ten styl pozwala środowisku Doxygen wyodrębnić specjalne polecenia, które zaczynają się od {{incode|\}} lub {{incode|@}}, podczas gdy styl Pythonic nie. Dlatego pożądane byłoby..."
  • curprev 11:0611:06, 14 May 2024Kaktus talk contribs 43,880 bytes +58 Created page with "===Konwersja stylu Pythonic na styl Doxygen==="
  • curprev 11:0611:06, 14 May 2024Kaktus talk contribs 43,822 bytes +3 Created page with "Dokumentacja powinna zawierać informacje podobne do poniższych oraz tworzyć odpowiednie odnośniki do poszczególnych modułów i klas."
  • curprev 11:0611:06, 14 May 2024Kaktus talk contribs 43,819 bytes +11 Created page with "Kompilacja dokumentacji przebiega tak samo jak dla źródeł C++. Jeśli oba pliki Python, {{incode|pyexample_a.py}} i {{incode|pyexample_b.py}}, z różnymi stylami komentowania znajdują się w tym samym katalogu, oba zostaną przetworzone."
  • curprev 11:0511:05, 14 May 2024Kaktus talk contribs 43,808 bytes +41 Created page with "===Kompilacja dokumentacji==="
  • curprev 11:0511:05, 14 May 2024Kaktus talk contribs 43,767 bytes −8 Created page with "W poniższym przykładzie bloki dokumentacji zaczynają się od podwójnych znaków hash {{incode|##}}. Jeden pojawia się na początku, aby wyjaśnić ogólną zawartość tego modułu (pliku). Następnie są bloki przed definicjami funkcji, klas i metod klas, a jeden blok znajduje się po zmiennej klasy. W ten sposób Doxygen wyodrębni dokumentację, rozpozna specjalne polecenia {{incode|@package}}, {{incode|@param}} i {{incode|@var}} i odpowiednio sformatuje tekst."
  • curprev 11:0411:04, 14 May 2024Kaktus talk contribs 43,775 bytes +24 Created page with "Jeśli pakiet został zainstalowany z poziomu użytkownika, może znajdować się w jego katalogu domowym, na przykład w {{incode|$HOME/.local/bin}}. Jeśli katalog ten nie znajduje się w katalogu {{incode|PATH}}, program nie zostanie znaleziony. Dlatego należy dodać katalog do zmiennej {{incode|PATH}}, albo w pliku {{incode|$HOME/.bashrc}}, albo w pliku {{incode|$HOME/.profile}}."
  • curprev 11:0211:02, 14 May 2024Kaktus talk contribs 43,751 bytes +59 Created page with "===Styl drugi: blok dokumentacji przed kodem==="
  • curprev 10:5710:57, 14 May 2024Kaktus talk contribs 43,692 bytes −3 Created page with "def PyMethod(self): '''Dokumentacja dla metody.''' pass }}"
  • curprev 10:5610:56, 14 May 2024Kaktus talk contribs 43,695 bytes −4 Created page with "def __init__(self): '''Konstruktor.''' self._memVar = 0"
  • curprev 10:5610:56, 14 May 2024Kaktus talk contribs 43,699 bytes +6 Created page with "class PyClass: '''Dokumentacja dla klasy. Więcej szczegółów. '''"
  • curprev 10:5610:56, 14 May 2024Kaktus talk contribs 43,693 bytes +5 Created page with "def func(): '''Dokumentacja dla funkcji. Więcej szczegółów. ''' pass"
  • curprev 10:5510:55, 14 May 2024Kaktus talk contribs 43,688 bytes +9 Created page with "{{Code|code= '''@package pyexample_a Dokumentacja dla tego modułu. Więcej szczegółów. '''"
  • curprev 10:5510:55, 14 May 2024Kaktus talk contribs 43,679 bytes +33 Created page with "W poniższym przykładzie jeden docstring znajduje się na początku, aby wyjaśnić ogólną zawartość tego modułu ''(pliku)''. Następnie docstringi pojawiają się wewnątrz definicji funkcji, klas i metod klas. W ten sposób Doxygen wyodrębni komentarze i zaprezentuje je w niezmienionej formie, bez modyfikacji."
  • curprev 10:5410:54, 14 May 2024Kaktus talk contribs 43,646 bytes +54 Created page with "===Styl pierwszy: Dokumentacja Pythonic==="
  • curprev 10:5310:53, 14 May 2024Kaktus talk contribs 43,592 bytes +130 Created page with "Uwaga: * Pierwsza opcja jest preferowana, aby zachować zgodność ze standardami [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8], [https://www.python.org/dev/peps/pep-0257/ PEP257] i większością wytycznych dotyczących stylu pisania w środowisku Python ''(patrz [https://realpython.com/python-pep8/ 1], [https://realpython.com/documenting-python-code/ 2])''. Zaleca się używanie tego stylu, jeśli zamierzasz tworzyć udokumentowane źródła pr..."
  • curprev 10:1910:19, 14 May 2024Kaktus talk contribs 43,462 bytes +53 Created page with "Istnieją dwa sposoby tworzenia bloków dokumentacji dla Python: # W środowisku Python, używając „docstringów”, czyli bloku tekstu otoczonego <code><nowiki>''potrójnymi cudzysłowami''</nowiki></code> bezpośrednio po definicji klasy lub funkcji. # W środowisku Doxygen, umieszczanie komentarzy przed definicją klasy lub funkcji. W tym przypadku do rozpoczęcia bloku dokumentacji używane są podwójne znaki mieszające {{incode|##}}, a następnie w kolejnych wi..."
  • curprev 10:1810:18, 14 May 2024Kaktus talk contribs 43,409 bytes +174 Created page with "Tekst wewnątrz specjalnego bloku dokumentacji jest analizowany przed zapisaniem go w plikach wyjściowych HTML i LaTeX. Podczas parsowania wykonywane są następujące kroki: * Formatowanie Markdown jest zastępowane odpowiednimi poleceniami HTML lub specjalnymi. * Wykonywane są specjalne polecenia wewnątrz dokumentacji. Zobacz sekcję [http://www.doxygen.nl/manual/commands.html Polecenia specjalne] w podręczniku, aby uzyskać wyjaśnienie każdego polecenia. * Jeśl..."

13 May 2024

(newest | oldest) View (newer 50 | ) (20 | 50 | 100 | 250 | 500)