Jak vložit zdrojový kód do dokumentace?

Ať již píšete bakalářku, diplomku, disertační práci nebo prostě jen dokumentaci k vaší aplikaci, zřejmě jste se zarazili nad otázkou jakým způsobem vkládat zdrojový kód. Pokud se domníváte, že obrázek je nejelegantnější řešení, čtěte rozhodně dále.

Vkládat zdrojový kód do dokumentace jako obrázek je podle mého názoru zhýralost největšího kalibru. V tištěné podobě je to při dostatečném rozlišení obrázku celkem jedno, ale v elektronické podobě nelze kód zkopírovat. Zároveň tím přicházíte o možnost editace textu a v případě změn je nutné pořídit nový screenshot. Ve chvíli kdy takových obrázků vložíte do dokumentace několik, její velikost neúnosným způsobem naroste.

Zdrojový kód vkládejte jedině jako text

Správnou možností je vkládání zdrojového kódu jako text, ale i to by mělo mít svá specifikaci. Přeci jen, když ponecháte formát textu stejný jako u obsahu, vložený kód zanikne. Pro zdrojový kód byste měli používat neproporcionální bezpatkový font, tedy například Courier New, Lucida Concosle a další, v závislosti na vašich preferencích a vložit celý kus kódu do textového pole.

Jak vložit zdrojový kód do Wordu tak, aby vypadal stejně jako v IDE

Pokud byste rádi zachovali při vkládání do Wordu formátování svého vývojového prostředí, mám pro vás pár tipů jak toho dosáhnout.

Notepad++

Požadovaný text si označte a místo Ctrl+C a Ctrl+V běžte do menu Pluginy->NppExpport a vyberte položku „Copy HTML to clipboard“. Následně již stačí vložit obsah schránky do Wordu a máte vn ěm zdrojový kód se zvýrazněnou syntaxí.

NetBeans

Dříve fazolky neumožňovaly export kódu se zachováním syntaxe, ovšem to se změnilo (tuším, že od verze 7). Stačí v menu Soubor vybrat funkci „Print to HML“. Exportovat lze buď do souboru, nebo schránky, přitom lze nastavit, zda chcete také zachovat čísla řádků.

VisualStudio

Pokud chcete kopírovat také čísla řádků a chcete mít možnost celý proces ovládat, doporučuji plugin CopySourceAsHtml http://copysourceashtml.codeplex.com/ případně Extension Visual Studio 2010 Productivity Power Tools.

Jaké máte zkušenosti s formátováním zdrojového kódu v dokumentaci, případně jaký nástroj používáte vy?