Testowanie dokumentacji Pod
Kiedy napiszę dokumentację, mogę sprawdzić, czy zrobiłem to poprawnie. Kiedy inni użytkownicy będą ją czytać, nie powinni otrzymywać ostrzeżeń o złym formatowaniu, a błędy składniowe nie powinny uniemożliwiać im lektury. Po co komu dokumentacja, jeśli nie można jej nawet przeczytać?
Sprawdzanie dokumentacji Pod
Pod::Checker
to rodzaj translatora Pod, który jednak nie przekształca dokumentacji w inny format, ale sprawdza jej poprawność. Kiedy znajdzie coś podejrzanego, wypisuje ostrzeżenia. W skład dystrybucji Perla wchodzi narzędzie podchecker
, które przypomina polecenie perl -c
, ale służy do sprawdzania dokumentacji Pod. Jest to w rzeczywistości programowa wersja modułu Pod::Checker
, który stanowi podklasę
Get Perl. Mistrzostwo w programowaniu now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.