PasDoc – tworzenie dokumentacji projektów

Podczas szkolenia nauczymy Cię obsługi PasDoc (https://pasdoc.github.io) – narzędzia open-source służącego do dokumentacji kodu w Pascalu i Delphi.

Założenia kursu:

1. Zaczniemy od podstawowych sposobów dokumentowania kodu przy pomocy komentarzy w interfejsie oraz znaczników @
   .
2. Przejrzymy zaawansowane funkcje, jak auto-linking, auto-abstract, używanie komentarzy z implementacji, używanie dokumentacji z dodatkowych plików, specjalne strony, dostosowanie dokumentacji HTML do stylu naszej witryny (nagłówki, CSS etc.)
   .
3. Przejrzymy kod samego PasDoc, nauczymy się różnych sposobów rozszerzanie i dostosowywania go do naszego projektu. Np. używanie komponentów PasDoc w naszej aplikacji, przetwarzanie wyniku PasDoca w formacie SimpleXML, lub, jako ostateczna opcja, modyfikacja samego kodu PasDoc
   .
4. Większość zagadnień przećwiczymy w praktyce dokumentując istniejący lub wymyślony na potrzeby ćwiczeń projekt.

.
Kurs prowadzony jest przez współautora i obecnego lidera projektu PasDoc, Michalisa Kamburelisa.

Zakres i tematyka szkolenia obejmuje następujące zagadnienia:

• Podstawowe zasady używania PasDoc
• Sugerowane zasady pisania dokumentacji aby była zwięzła i faktycznie użyteczna
• Auto-linking, auto-abstract, dokumentacja z dodatkowych plików
• Generowanie dokumentacji której styl jest dostosowany do danego projektu (jak https://castle-engine.io/apidoc/html/ )
• Rozszerzanie kodu PasDoc oraz osadzanie komponentu PasDoc we własnych narzędziach

Trener prowadzący szkolenie – Michalis Kamburelis

Twórca Castle Game Engine, z miłości do open-source i gier komputerowych. Autor „Modern Object Pascal Introduction for Programmers”. Członek konsorcjum Web3D, łącznik z Khronosem (otwarte standardy 3D). Aktualny maintainer PasDoc.

Wykładowca podczas Zlotu Programistów Delphi w latach 2023 i 2024. Posiada certyfikat Embarcadero MVP.