Thread View: pl.comp.lang.asm
1 messages
1 total messages
Started by Bogdan (bogdro)
Sat, 24 Mar 2007 13:20
AsmDoc - generator dokumentacji HTML dla ASM
Author: Bogdan (bogdro)
Date: Sat, 24 Mar 2007 13:20
Date: Sat, 24 Mar 2007 13:20
43 lines
2570 bytes
2570 bytes
Witam. Ogłaszam ukończenie prac nad pierwszą wersją skryptu AsmDoc, służącego do generowania dokumentacji HTML z plików źródłowych asemblera, dokładnie tak jak javadoc dla Javy. Obsługiwana jest większość istotnych opcji (uruchomienie bez opcji wyświetla pomoc) i tagów javadoc, komentarze dokumentujące powinny się zaczynać od podwójnego średnika (i kończyć tym samym) lub od sekwencji /** (i kończyć tradycyjnie: */), podobnie jak w Javie, np.: ;; ; Sumuje ECX i EBX, a wynik zwraca w EAX. ; @param EBX - pierwsza liczba ; @param ECX - druga liczba ; @return EAX - suma dwóch liczb ;; sumuj: lea eax, [ebx+ecx] ret Komentarz powinien następować bezpośrednio przed linią zaczynającą procedurę/funkcję/zmienną. wyjątkiem jest komentarz nagłówkowy całego pliku, po którym musi być co najmniej jedna linia pusta. Elementy bez komentarza nie są umieszczane w dokumentacji. Skrypt jest napisany w Perlu (mój ulubiony język do przetwarzania tekstu) i wymaga Perla >= 5.8.0 z garstką standardowych modułów. Kodowanie treści skryptu to UTF-8. Skrypt generuje strony w prawidłowym HTML, bez Javascriptu, w tej chwili w języku polskim lub angielskim (wykrywane automatycznie lub podawane ręcznie opcją -lang), co można łatwo rozszerzyć. Zapraszam do testowania, może komuś się przyda: http://rudy.mif.pg.gda.pl/~bogdro/programy.htm (na dole). Wskazówka na początek: radzę używać opcji '-d katalog', by nie zaśmiecać katalogu bieżącego. -- Pozdrawiam, Bogdan (Linux i FreeDOS) Kurs assemblera x86 (DOS i Linuks): http://rudy.mif.pg.gda.pl/~bogdro Grupy dyskusyjne o asm: pl.comp.lang.asm alt.pl.asm alt.pl.asm.win32 Rozmawiaj bezpiecznie: www.JabberPL.org Surfuj anonimowo: tor.eff.org
Thread Navigation
This is a paginated view of messages in the thread with full content displayed inline.
Messages are displayed in chronological order, with the original post highlighted in green.
Use pagination controls to navigate through all messages in large threads.
Back to All Threads