🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: pl.comp.lang.asm
Article #1010

AsmDoc - generator dokumentacji HTML dla ASM

#1010
From: Bogdan (bogdro)
Date: Sat, 24 Mar 2007 13:20
43 lines
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
Technical Details
Message-ID: <eu38jm$mce$2@inews.gazeta.pl>
Path: mbox-mo1.pugleaf.net!news-archive.icm.edu.pl!news.gazeta.pl!not-for-mail

Show Full Headers
Complete Article Headers
Path: mbox-mo1.pugleaf.net!news-archive.icm.edu.pl!news.gazeta.pl!not-for-mail
From: "Bogdan (bogdro)" <bogdan@poczta.gazeta.pl>
Newsgroups: pl.comp.lang.asm
Subject: AsmDoc - generator dokumentacji HTML dla ASM
Date: Sat, 24 Mar 2007 14:20:55 +0100
Organization: "Portal Gazeta.pl -> http://www.gazeta.pl"
Lines: 43
Message-ID: <eu38jm$mce$2@inews.gazeta.pl>
NNTP-Posting-Host: 87-205-238-143.adsl.inetia.pl
Mime-Version: 1.0
X-Trace: inews.gazeta.pl 1174742455 22926 87.205.238.143 (24 Mar 2007 13:20:55 GMT)
X-Complaints-To: usenet@agora.pl
NNTP-Posting-Date: Sat, 24 Mar 2007 13:20:55 +0000 (UTC)
X-User: bog.d
User-Agent: Thunderbird 1.5.0.10 (X11/20070221)
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit