Automatická tvorba nápovědy pro programy v Delphi

English

Na této stránce můžete najít můj program pro automatickou tvorbu nápovědy pro jednotky a komponenty v Delphi. Program dokáže projít zdrojový text jednotky a vygeneruje kostru nápovědy ve formátu RTF, plus HPJ soubor s projektem pro Microsoft Help Compiler. Program vznikl jako semestrální práce z předmětu Programovací jazyky na Katedře počítačů FEL ČVUT.

Schopnosti

Program je schopen provést syntaktickou a lexikální analýzu interface části jednotek v Object Pascalu z Delphi verze 5. V průběhu tohoto procesu projde zdrojové texty všech jednotek, na které program odkazuje (což ovšem není zrovna ideální chování). Výstupem programu je Help Project a RTF soubor, jejichž kompilací se získá HLP soubor, který vypadá stejně jako nápověda Delphi, ovšem obsahuje připravenou strukturu podle zpracovávaného souboru (jedna stránka pro každý typ, funkci, metodu, atd.). Do souboru pak stačí doplnit popis příslušných položek.

Download

V zabaleném souboru naleznete kompletní zdrojové texty programu, EXE soubor řádkové verze programu a malé množství dokumentace (MS Word). Navíc jsou tam potřebné bitmapy, použité ve vytvářených souborech.

helpcreator.zip (128,954B ZIP)

Vlastnosti chybějící a jiné

Jelikož program vznikl jako semestrální práce, je mnoho vlastností, které by bylo vhodné přidat. Z těch nejzákladnějších vybírám:

Závěrečné poznámky

Původní ideou bylo program dokončit do „profesionální“ podoby a zveřejnit např. na SourceForge. Jelikož ovšem semestr skončil, já na programu přestal pracovat. A dnes ani já tento program téměř nevyužívám.

HelpCreator je pochopitelně pod GNU licencí, takže pokud ho snad chcete rozšiřovat, nic vám v tom nebrání. V tom případě bych ocenil, kdybyste mi o tom dali vědět (a ukázali mi výsledky své práce).

Pokud chcete nějaký obdobný nástroj, který je ovšem „hotový“, vřele vám doporučuji zkusit třeba Doxygen. Ten má snad veškeré vlastnosti uvedené v předcházející tabulce. Jedná se sice o nástroj původně určený pro C++, resp. Javu, ale s pomocí programu Pas2Dox to jistě zvládnete.

NAVRCHOLU.cz