Perl/Ćwiczenie 4

A. Dokumentacja twojego programu

Używając techniki zwanej "Plain old Documentation" (POD), wybierz jeden z napisanych przez Ciebie programów w Perlu, opisz go, napisz co robi, jak działa i jakie opcje akceptuje. Będziesz musiał napisać dokumentację w tym samym pliku co kod programu, używając do tego specjalnych znaczników języka POD [1]

Sprawdź czy po dodaniu do pliku dokumentacji, Twój program nadal pracuje poprawnie.

Używając narzędzia pod2text, utwórz tekstowy plik pomocy dla Twojego programu. Sprawdź czy ma on miły i łatwy do czytania format. (Będziesz potrzebował skorzystać z programu "wyciągającego" dokumentację z Twojego programu do innego pliku tekstowego).

B. Tworzenie dokumentacji HTML

Korzystając z zestawu narzędzi POD, wyciągnij dokumentację z Twojego programu do pliku HTML. Otwórz plik HTML w przeglądarce i sprawdź czy jest ładnie sformatowany i prosty do odczytania.

Jeśli chcesz korzystać z LaTeX'a lub man'a, spróbuj skompilować swoją dokumentację odpowiednio jako plik LaTeX lub Troff.

C. Asystent testów

Find a testing framework which will allow you to write tests for your Perl program, to automatically test its functionality. Taking a complex program from a previous exercise, write tests which check for correct behaviour in each part of your program.

Insert a deliberate error in the program being tested, and check that the error is spotted by the test-suite. See whether you can make the program display incorrect results and still pass the test-suite. (if so, modify the test-suite to detect this incorrect version of the program)

Re-write the program from scratch using a different method for some of the functions. Check that the new program passes your test-suite.

D. Połączenie wszystkiego

Napisz program, który skanuje skrypt Perla, wyświetla rozmiar programu, liczbę komentarzy i oblicza gęstość programu (liczba wyrażeń składni, podzielona przez linie kodu).

Wykaż wartość programu przez sprawdzenie i oszacowanie jaki jest koszt czasu na linię kodu, w celu zastosowania programu w przemyśle.

Wykaż szacunkową liczbę błędów w programie, patrząc na spodziewaną liczbę błędów na 1000 linii kodu dla średniego, przeciętnego programu.

Napisz dokumentację i zestaw testów dla Twojego nowego programu.

Pobierz losowy skrypt Perla z Internetu i zobacz jak on wypada w porównaniu z Twoim miernikiem jakości kodu.

Write a program which scans a Perl script and displays the size of the program, the number of comments, and calculates the density of the program (number of statements divided by lines of code)

Display the value of the program by looking-up an estimate of how much it costs per line of code to develop a program in industry.

Display the estimated number of errors in the program by looking-up the expected number of errors per thousand lines of code for an average program.

Write the documention and test-suite for your new program.

Download a random perl script from the internet, and see how it matches up on your code-quality meter.

Odpowiedzi