Rozdział 15. Wprowadzenie do dokumentacji

Ta część książki kończy się przedstawieniem technik i narzędzi wykorzystywanych w dokumentowaniu kodu Pythona. Choć kod Pythona został zaprojektowany tak, by sam z siebie był czytelny, kilka dobrze rozmieszczonych, zrozumiałych dla użytkowników komentarzy może pomóc innym osobom pojąć sposób działania naszego programu. Jak się przekonasz, Python posiada zarówno odpowiednie polecenia, jak i narzędzia ułatwiające tworzenie dokumentacji kodu. W szczególności omawiany w tym rozdziale system PyDoc może tworzyć wewnętrzną dokumentację modułu jako zwykły tekst wyświetlany w powłoce lub jako dokumenty HTML w przeglądarce internetowej.

Choć jest to koncepcja związana raczej z narzędziami, prezentuję ją w tym ...

Get Python now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.