Scott Tiger Tech Blog

Blog technologiczny firmy Scott Tiger S.A.

Narzędzia dokumentowania kodu ActionScript

Autor: Krzysztof Nielepkowicz o 23. sierpnia 2010

Procesy tworzenia oprogramowania mogą się od siebie nawet bardzo różnić ale w każdym z nich ważne jest dokumentowanie kodu.  Jednym z lepszych narzędzi w historii informatyki jakie powstały w tym celu jest javadoc dla języka Java.  Dla ActionScriptu również stworzono takie narzędzia, jest ich przynajmniej kilka i bardzo się różnią od siebie. W tym artykule przedstawię trzy najbardziej interesujące: 

  •  asDoc – najpopularniejsze narzędzie, bo dostarczone przez Adobe. Generowana dokumentacja najbardziej przypomina efekt działania javaDoc’a, jest przejrzysta i szybka w navigowaniu. Niestety narzędzie jest bardzo trudne w obsłudze, kapryśne i nieintuicyjne.  Użycie asDoc’a bardzo ułatwia narzędzie asdocr – jest to świetna nakładka graficzna.
  • Ortelius – jest to łatwe i szybkie w użyciu narzędzie do sporządzania dokumentacji  posiadającej elegancki layout. Narzędzie wymaga zainstalowanego .NET Framework
  • NaturalDocs – kolejne narzędzie generujące dokumentację, również szybkie i proste w użyciu ciekawą funkcją w wygenerowanym dokumencie jest wyszukiwarka klas.  Do uruchomienia wymaga zainstalowania interpretera Perl’a, polecany jest ActivePerl.

Tags: , , , , ,
Napisany w ActionScript, Języki programowania | Brak komentarzy »