Dokumentacja oprogramowania obiektowego

Dokumentacja oprogramowania dostarcza twórcom i u¿ytkownikom oprogramowania przydatny opis tego, co oprogramowanie robi, jak dziäa, jak jest zbudowane i jak ma by¿ u¿ywane. Na przyk¿ad, podr¿cznik u¿ytkownika pokazuje, w jaki sposób u¿ytkownicy powinni wchodzi¿ w interakcj¿ z produktem; natomiast dokument projektowy pomaga programistom w trakcie jego rozwoju i konserwacji. G¿ównym wyzwaniem jest skonstruowanie zautomatyzowanego narz¿dzia, które mo¿e tworzy¿, na ¿¿danie, dynamiczn¿ dokumentacj¿ kodu ¿ród¿owego oprogramowania. Ksi¿¿ka ta przedstawia automatyczne podej¿cie zwane podej¿ciem Al-Msie'deen do generowania dokumentacji oprogramowania na ¿¿danie dla kodu oprogramowania. Nowo¿¿ tego podej¿cia polega na tworzeniu dynamicznej dokumentacji kodu oprogramowania na poziomie pakietów, klas, atrybutów i metod. Dokumentacja kodowa jest pisemnym tekstem lub ilustrowanymi schematami, które przedstawiaj¿ informacje o wszystkich poziomach ziarnisto¿ci kodu, od poziomu pakietów do poziomu metod. Podej¿cie Al-Msie'deen generuje ró¿ne rodzaje dokumentacji kodowej, takie jak podsumowania kodu, etykiety, metryki, chmury tagów i dokumenty graficzne.