Źródło: Arkusze CKE
Który z poniższych elementów należy uwzględnić w dokumentacji kodu programu?
Warianty odpowiedzi
-
A
Plan marketingowy aplikacji
-
B
Szczegóły konfiguracji serwera
-
C
Opis funkcji, klas i zmiennych w kodzie
-
D
Lista błędów wykrytych podczas testów
Wyjaśnienie
Żelazna zasada w branży mówi, że kod pisze się raz, a czyta wielokrotnie. Dokumentacja kodu jest tworzona z myślą o innych programistach oraz o Tobie za kilka miesięcy.
Jej najważniejszym elementem jest precyzyjny opis funkcji, klas oraz zmiennych. Pozwala to szybko zrozumieć, za co odpowiada dany moduł i jak z niego skorzystać.
Dobrze udokumentowany kod drastycznie skraca czas potrzebny na rozwój i utrzymanie aplikacji.