Dokumentační novinky z Redmondu

Pískové zámky dokumentace

Jestli programátoři něco nesnášejí, je to psaní dokumentace. Na hranici snesitelnosti je ještě psaní XML komentářů přímo do kódu - zejména proto, že je nativně podporování Visual Studiem. Výsledkem takového snažení může být XML soubor, který VS 2005 využívá k nápovědě v IntelliSense. Při troše snahy se z týchž podkladů dá vygenerovat HTML dokumentace třeba ve stylu MSDN Library.

Ona "trocha snahy" dosud ve většině případů znamenala použití geniálního nástroje jménem NDoc. Ten ovšem nepodporuje .NET 2.0 a jeho další vývoj byl zastaven, protože jeho autor byl znechucen nedostatkem jakékoliv podpory vývojářské komunity.

Microsoft anoncoval vlastní nástroj v podobném duchu - je znám pod kódovým označením Sandcastle. K dispozici je jeho červencová Community Technology Preview. K přívětivosti a jednoduchosti ovládání NDocu mu pravda ještě hodně chybí, jeho ovládání je poněkud... liunxové :-) Pokud jste líní psát komplikované příkazy v command line, doporučuji podívat se na tento jednoduchý program který umí automagicky vygenerovat příslušné dávkové soubory.

MSDN Library ke stažení

Lidé se mne často ptají na doporučenou literaturu. Dostávají mne tím trochu do úzkých, protože je obvykle neuspokojí moje dva oblíbené odkazy: www.google.com a msdn.microsoft.com.

MSDN je oficiální dokumentace k většině produktů, které vývojáře mohou zajímat. K dispozici je její online verze na webu a nebo si ji můžete lokálně nainstalovat. Zatímco online verze je od počátku věků zdarma dostupná komukoliv, verze k instalaci byla až dosud za peníze v rámci MSDN Subscription. Nyní si ji celou můžete stáhnout. Pokud se vám ta tři cédéčka stahovat nechce, přijďte na Developer Days 2006, kdežtě byste je měli jako účastníci dostat ve fyzické podobě.

Celkově je milé, že Microsoft pokračuje v nastoupeném trendu a postupně uvolňuje zdarma velké množství pro vývojáře užitečných věcí. Nyní je možné pro Windows a .NET platformu velmi pohodlně vyvíjet i relativně složité aplikace, aniž byste museli za nástroje, dokumentaci, DB stroj a podobně platit.

  • Altairis
  • Nemesis
  • Microsoft MVP
  • IIS
  • ASP.NET