P9: Javadoc, anotácie a zopár ďalších vecí / P10: Programovací jazyk C++: flexibilita a efektivita D

Zhrnutie prednášky

Prednáška sa venuje dokumentovaniu kódu v Jave pomocou nástroja Javadoc. Vysvetľuje, prečo komentáre potrebujeme: kód je presný, ale nevyjadruje zámer a nenapovie, ako ho používať. Na príklade hry s rytiermi a obrami ukazuje špeciálne komentáre so značkami ako @link a @param, HTML formátovanie a odkazy na triedy a výnimky. Vygenerovanie dokumentácie z Eclipse cez Project > Generate Javadoc demonštruje na výslednej HTML dokumentácii, kde sa automaticky dopĺňajú signatúry, hierarchia tried, serializovateľnosť a vyhadzované výnimky. Aspektovo orientované balíky (Logging, Extensions) treba z generovania vylúčiť, lebo im Javadoc nerozumie. Na úvod zaznel aj plán ďalších tém (C++ a C# v porovnaní s Javou) a organizačné poznámky k projektu.

• - Komentáre vysvetľujú zámer a spôsob použitia kódu, ktorý samotný kód nevyjadrí.
• - Javadoc komentáre používajú značky ako @param a {@link} a základné HTML formátovanie.
• - Dokumentácia sa generuje v Eclipse cez Project > Generate Javadoc a vzniká z nej HTML API dokumentácia.
• - Generátor automaticky dopĺňa signatúry metód, dedičnosť, serializovateľnosť a vyhadzované výnimky.
• - Aspektovo orientované balíky (Logging, Extensions) treba z generovania vylúčiť, lebo ich Javadoc nezvláda.
• - Vlastné výnimky sa definujú odvodením od triedy Exception a dajú sa umiestniť do samostatného balíka, ktorý treba importovať.
• - Nekomentované triedy a metódy generujú len upozornenia; kvalita opisu je dôležitejšia než jeho rozsah.

Zhrnutie pripravené s pomocou AI z prepisu videa.