Documentation Insight Express

vložil Radek Červinka 2. listopadu 2011 00:02

Součástí XE2 je mimo jiné i lehce očesaná verze Documentation Insight od firmy DevJet. Tento nástroj lze koupit i pro předchozí verze, ale součástí XE2 je verze zdarma.

Cílem je zjednodušení psaní dokumentace v kódu. Nástroj vyvoláme přes CTRL+SHIFT+D (popřípadě přes menu Tools …) stojíce na místě, které chceme dokumentovat (tj. např. metodě). Vyvolaný dialog podporuje základní elementy (kompletní sezname včetně cross referencí je v nápovědě).

Documentation Insight editor

Překliknutím zobrazíme náhled

Documentation Insight preview

A následně při zastavení nad dokumentovanou částí získáme toto (zároveň lze vidět vygenerované data jako komentáře)

Documentation Insight IDE

které se dají zavřít:

Documentation Insight IDE 2

Jinak je součástí instalace (i předchozí verze) i nástroj "bin\GenDocCLI.exe", který dokáže vygenerovat z projektu dokumentaci. Buďto ho můžete spustit jako commandline program s parametrem projektu (viz. help) nebo z IDE z modelovací části z popupmenu.


Nabízíme Delphi školení a konzultace na různá témata, primárně ve Vaší firmě.

Tagy: ,

Nástroje

Komentáře

2.11.2011 16:07:46 #

Zdeněk Vašků

To je dobrá věc.

Zdeněk Vašků

3.11.2011 16:38:25 #

bullhead

Zvláštní, ani Express edice, ani plná (podotákám že koupená:-)) přez CTRL+ALT+D mi NEfunguje. Mě to jede jen když napíšu "xdoc" a dám CTRL+J.

Někomu to na CTRL+ALT+D funguje?

B.

p.s. ...a určitě jsem nepřemapovával žádné klávesy

p.p.s. ..."bin\GenDocCLI.exe" jsem neznal! Zrovna hledám tool které to podporuje a nestojí 1000dolarů jak dot-o-matic, díky za info

bullhead

3.11.2011 16:45:47 #

Radekc

Hmm, ono je to totiz CTRL+SHIFT+D, viz Options toho nástroje. Sorry - opraveno

Radekc

3.11.2011 16:47:00 #

Radekc

Zkousel jsi PasDoc nebo DoxyGen?

Radekc

3.11.2011 16:59:11 #

bullhead

- CTRL+SHIFT+D
...mi otevře/zavře Documentation Insight (ať už zadokované nebo otevřené), ale pokud chci opravdu do kódu dostat xdoc zančky (=/// apod) tak jedině přez "XDOC" a "ctrl+j" (zrovna se snažím rozšířit tu šablonu o další tagy).

- PasDoc
...kdysi ano, ale ten nepodporoval XDOC notaci (=xml ala VS) ale jen PasDoc notaci (ta už je asi překonaná). Na DoxyGen se podívám.

B.

bullhead

3.11.2011 17:06:38 #

Radekc

>mi otevře/zavře Documentation Insight
a dole je zalozka design a preview - viz prvni obrazek v tomto clanku. Tak si prosim preklikni na zalozku Design

Radekc

3.11.2011 17:16:45 #

bullhead

...aaaaa ...tak v plné verzi je to jinak - NEjsou žádné záložky, jen nahoře je nějaké žlutá ikonka "switch between editing a reding" - pak jde v tom oklně opravdu editovat a po save se to promítne do kódu.

Postup:
1. otevření okna Documentation Insight
2. klik myší na to co chce člověk pookomentovat
3. objeví se prázdne tagy
4. klik na žlutou ikonu "edit mode"
5. něco do tagu dopsat
6. klik na save v Documentation Insight

B.

p.s. ...trochu mne irituje že generuje pokaždé:
  {$REGION 'Documentation'}
{$ENDREGION}
- to není nutné, XDOC dokumentace se dá defatultně v Delphi zbalit bez regionů ...pokusím se to vypnout

p.p.s ...díval jsem se teď na PasDoc, pokud se dobře dívám pořád neumí XDOC - jen PASDOC


bullhead

3.11.2011 17:20:59 #

bullhead

...v option se dá ODšrtnout "Surround documentation withing a region" a pak to již NEgeneruje  "{$REGION 'Documentation'}" a je to čistý XDOC

...takže zbývá už jen rozjet korektní generování do CHM (nebo něčeho vyššího) jako program dokumentace

díky za navedení!

B.

bullhead

3.11.2011 17:38:44 #

bullhead

Ještě pro info.

Pokud jsem něco nepřehlédl tak to umí jen okometovat Classy, funknce, procedury, variable ve var na úrovni unitu, ale např. variable ne úrovni už samotné procedury/funkce nebo komentáře v kódu to už ignoruje (takže tam zbýva "XDOC" + "CTRL+J"). Je zvláštní že ikonka "zabal všechny konmentáře" zabalí i ty kometáře co nevidí:-).

B.

bullhead

3.11.2011 23:50:21 #

Radekc

Ohledně toho generování - http://forums.devjet.net/compiling-documentation-t51.html
Možná, že jako kupec plné verze by jsi mohl zkusit to vlákno oživit.

Radekc

4.11.2011 11:59:36 #

bullhead

Rozumím:-). Ale to je skoro rok kdy slibovali nějakou verzi a dodnes nic.

Našel jsem X toolu, hodně i freewarových (Precision helper apod.), prošel jsem možnosti Delphi (v option v Delphi se dá zapnout generovat XML dokumentaci), pokusím se to nějak komplexně rozjet (kod->kompilace->chm nebo něco podobného) a až budu mít nějaké reálné výsledky dám to zde - třeba to někdo využije.


B.

bullhead

Komentování ukončeno

Naše nabídka

Partial English version.

MVP
Ing. Radek Červinka - Embarcadero MVP
profil na linkedin, Twitter:@delphicz

Nabízím placené poradenství a konzultace v oblasti programování a vývoje SW.
Dále nabízíme i vývoj speciálního software na zakázku.

Neváhejte nás kontaktovat (i ohledně reklamy nebo burzy práce).

Pokud chcete podpořit tento server libovolnou částkou, můžete použít PayPal. Moc děkuji.

Delphi Certified Developer

O Delphi.cz

Delphi je jediný moderní RAD nástroj podporující tvorbu nativních aplikací pro platformu Win32, Win64 , Mac OSX a na iPhone a Android (s výhledem na další platformy díky FireMonkey) na současném trhu (včetně Windows 8.1).

V současnosti je světová komunita přes dva miliónů vývojářů.

Delphi.cz je nezávislý portál pro uživatele Delphi. Portál není koncipován pro úplné začátečníky, i když i ti se zde nebudou nudit, ale spíše na programátory, kteří již něco znají a chtějí své znalosti dále rozvíjet a sledovat novinky.

Anketa

Poslední komentáře

Comment RSS