29.7. Stosowanie fragmentów kodu
Współautor: Eric Redmond
Jednym z przydatnych mechanizmów frameworku Doxia jest obsługa fragmentów kodu. Fragmenty kodu mają postać makr zapisanych w plikach i reprezentowanych przez identyfikatory. Fragmenty kodu to wygodny sposób wstawiania lub odwoływania się do ważnych bloków kodu źródłowego w ramach dokumentacji technicznej. Definicja fragmentu kodu ma następującą postać:
%{snippet|id=myID|file=some.file}Fragment kodu można zdefiniować, umieszczając blok kodu źródłowego pomiędzy odpowiednio sformatowanymi komentarzami. Makro frameworku Doxia przeszuka dany plik pod kątem występowania komentarza otwierającego START SNIPPET: identyfikator i komentarza kończącego END SNIPPET: identyfikator. Poniżej przedstawiono ...
Get Java. Praktyczne narzędzia now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
