Po zapoznaniu się z poniższymi krokami wykonaj zadanie stosując się do wskazówek i poleceń.

1. Przejdź do zakładki Wiki by utworzyć tam serię stron dokumentacji

2. Stwórz stronę główną, którą nazwij Spis treści

3. Stwórz cztery podstrony, które nazwij odpowiednio: JavaDoc, PyDoc, Sphinx oraz phpDocumentator

4. Stwórz ostatnią podstronę o nazwie Autor

5. Uzupełnij wszystkie strony Wiki treściami zaprezentowanymi w punkcie 2

Spis treści

Narzędzia offline do tworzenia dokumentacji:

1. JavaDoc dla języka Java tworzy witrynę dokumentacji

2. PyDoc dla języka Python tworzy dokument HTML lub Python'owski plik pomocy terminalowej

3. Sphinx dla języka Python tworzy witrynę dokumentacji

4. phpDocumentator dla języka PHP tworzy witrynę dokumentacji

Narzędzie JavaDoc

Link: https://docs.oracle.com/javase/9/javadoc/javadoc-command.htm

Instalacja

To narzędzie jest dostarczane wraz z JDK przez firmę Oracle

Użycie

javadoc [packages|source-files] [options][@files]

javadoc MojaKlasa.java

javadoc *.java

Wynik

Tutaj uczeń prezentuje screen z wynikiem działania w/w polecenia wykonanego na swoim komputerze

Narzędzie PyDoc

Link: https://docs.python.org/3/library/pydoc.html

Instalacja

To narzędzie jest dostępne jako moduł do instalacji z managera pakietów pip przez twórców Python'a

pip install pydoc

python3 -m pip install pydoc

Użycie

Gdy moduł pydoc jest zarejestrowany jako aplikacja w systemie opercyjnym:

pydoc -w MojaKlasa

pydoc -w MojModul/MojaKlasa

Gdy moduł nie jest rozpoznawalny jako aplikacja dostępna w systemie:

python3 -m pydoc -w MojaKlasa

python3 -m pydoc -w MojModul/MojaKlasa

Wynik

Tutaj uczeń prezentuje screen z wynikiem działania w/w polecenia wykonanego na swoim komputerze

Narzędzie Sphinx

Link: https://www.sphinx-doc.org/en/master/usage/quickstart.html

Instalacja

To narzędzie jest dostępne jako moduł do instalacji z managera pakietów pip przez społeczność Python'a

pip install sphinx

python3 -m pip install sphinx

Użycie

sphinx-quickstart

sphinx-build -b [format] [sourcedir] [builddir]

sphinx-build -b html katalogKlas mojaDokumentacja

Wynik

Tutaj uczeń prezentuje screen z wynikiem działania w/w polecenia wykonanego na swoim komputerze

Narzędzie phpDocumentator

Link: https://www.phpdoc.org/

Instalacja

To narzędzie jest dostępne do pobrania jako PHParchiwum pip przez ?społeczność PHP

Użycie

./phpDocumentator -d katalogKlas mojaDokumentacja

Wynik

Tutaj uczeń prezentuje screen z wynikiem działania w/w polecenia wykonanego na swoim komputerze

Autor

[klasa] [imie] [nazwisko]

• E-mail: [imie].[nazwisko]@zsegw.pl
• Phone: 789-456-123
• School: ZSE, room 201, 2-floor
• Link RtD: [wstaw_URL_do_dokumentacji_RtD]