SZARP PLC HOWTO | ||
---|---|---|
Poprzedni | Rozdział 13. Automatycznie generowana dokumentacja do program�w technologicznych przy u�yciu skryptu docgen | Następny |
Skrypt docgen automatycznie sprawdza poprawno�� ortograficzn� sekcji komentarza og�lnego (opis: Sekcja 13.2.10). Sprawdzanie wykonywane jest przy u�yciu programu aspell w trybie odpowiednim dla dokument�w w formacie HTML. Ignorowane s� s�owa o d�ugo�ci mniejszej b�d� r�wnej cztery znaki, co pozwala unikn�� niepoprawnego wykrywania nazw skr�conych (z IPK) jako b��dnych ortograficznie.
Domy�lnym sposobem raportowania b��d�w jest wy�wietlenie ich na standardowym wyj�ciu b��d�w. Jednak, w przypadku pracy wsadowej, przydatna jest mo�liwo�� wys�ania maila osobie, kt�ra jako ostatnia zmodyfikowa�a dany plik �r�d�owy. Informacje o tym kto ostatni zmodyfikowa� dany plik brane s� z log�w SVN, a nast�pnie lista b��dnych s��w wysy�ana jest na adres <author>@praterm.com.pl, gdzie cz�on <author> jest informacj� wydobyt� z SVN-a. Zachowanie takie mo�na w��czy� podaj�c prze��cznik -m w linii komend.
Poprzedni | Spis treści | Następny |
Automatycznie generowane opisy parametr�w na podstawie konfiguracji | Początek rozdziału | Dobre zwyczaje obowi�zuj�ce przy pisaniu dokumentacji |