Odcinek 16 - Generowanie dokumentacji z kodu źródłowego
Jak można ulepszyć lub uprościć tworzenie dokumentacji ? Jak zadbać o aktualność danych zawartych w dokumentacji ? Na te pytania odpowiem w odcinku, a materiały znajdziesz na https://github.com/sebastianczech/podcast-everything-as-a-code/tree/main/episode-016.
Jak wiemy już, jakie są zalety tego podejścia, by tę dokumentację przechowywać obok kodu źródłowego, by ją automatycznie aktualizować, przyjrzyjmy się, jakie mamy możliwości techniczne, by to osiągnąć. Tutaj ciężko wskazać jedno narzędzie, bowiem dla każdego z języków są to różne programy, narzędzia, frameworki. W Javie mamy Javadoc'a. Możemy tu użyć Doxygena czy ASCII doktora. W Pythonie możemy użyć Sphinx'a, PyDoc'a, JavaScript'cie JSDoc'a czy TypeDoc'a. W C++'ie Doxygena oraz również Sphinx'a. W Go mamy GoDoc'a.
Pokazano wszystkie 1 dopasowanie. Transkrypcja generowana automatycznie i niesprawdzana ręcznie — może zawierać błędy.
Kliknij, aby znaleźć fragmenty, w których pada.
Jak można ulepszyć lub uprościć tworzenie dokumentacji ? Jak zadbać o aktualność danych zawartych w dokumentacji ? Na te pytania odpowiem w odcinku, a materiały znajdziesz na https://github.com/sebastianczech/podcast-everything-as-a-code/tree/main/episode-016.