Łatwiejsze budowanie plików pomocy dzięki Sandcastle Help File Builder

Na CodePlex dostępny jest specjalny projekt, który pozwala w łatwiejszy sposób tworzyć dokumentację bibliotek wykorzystując narzędzie SandCastle.

W kompilatorze C(sharp) można włączyć opcję, że na podstawie specjalnych komentarzy ( poprzedzonych m. innymi ///) generowany jest specjalny plik XML który grupuje tak opisane informacje. Problem w tym, że w wersji 2005 nie ma mechanizmu generowania jakiś "zbiorczych" stron na podstawie takiego XML-a.

Właśnie do tego służy SandCastle. Warto dodać, że po zarzuceniu prac nad Ndoc jest w zasadzie jedynym, darmowym narzędziem do generowania "cywilizowanie" wyglądającej dokumentacji bibliotek.

Z komercyjnych narzędzi obsługujących nowe elementy składni w C# 2.0 można wymienić DocumentX: (http://www.innovasys.com/products/dx5/overview.asp).

Niestety - użycie SandCastle wymaga napisania dosyć skomplikowanych skryptów (generowanie pliku pomocy składa się z kilku etapów itp.). Wspomniany tu Help File Builder ma interfejs przypominający "stary" Ndoc, ale współpracuje właśnie z SandCastle.

Więcej szczegółów na temat tego projektu można znaleźć na CodePlex:http://www.codeplex.com/SHFB

Z ciekawszych możliwości:

- jest import ustawień z Ndoc-a

- Można generować nie tylko bibliotekę w formie HTML 2x (HxS) ale też CHM oraz witrynę WWW.

- Można połączyć dokumentację wielu plików DLL/Exe w jednym pliku pomocy

- projekt poprawia także pewne błędy w szablonach używanych przez SandCastle.

SandCastle (wersję December CTP) można pobrać z:

http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en

W celu komercyjnej reprodukcji treści Computerworld należy zakupić licencję. Skontaktuj się z naszym partnerem, YGS Group, pod adresem [email protected]

TOP 200