VSdocman - VSdocman
 | Tento článek má několik problémů. Prosím pomozte vylepši to nebo diskutovat o těchto otázkách na internetu diskusní stránka. (Zjistěte, jak a kdy tyto zprávy ze šablony odebrat) (Zjistěte, jak a kdy odstranit tuto zprávu šablony)
|
 | |
| Vývojáři | Helixoft |
|---|---|
| Stabilní uvolnění | 9.0 / 24. dubna 2019 |
| Operační systém | Okna |
| Typ | Generátor dokumentace |
| Licence | Proprietární |
| webová stránka | http://www.helixoft.com |
VSdocman je generátor dokumentace , který umožňuje komentování kódu a automatické generování technické dokumentace z C# a VB .NET projekty. Je přímo integrován do Vizuální studio jako rozšíření.
Přehled
VSdocman je rozšíření pro Visual Studio 2017, 2015, 2013 a 2012. Skládá se ze dvou hlavních částí - kompilátoru dokumentace a editoru komentářů. Kompilátor produkuje finální dokumentaci třídy v různých formátech. Editor komentářů poskytuje nástroje pro poloautomatické vkládání nebo úpravy komentářů XML, které používá kompilátor.[1]
Překladač dokumentace
Na základě uživatelského nastavení VSdocman naskenuje kód v projektech Visual Studio a automaticky vytvoří dokumentace. To lze provést přímo z uživatelského rozhraní VS nebo z příkazového řádku, např. v automatizovaném sestavení. Dokumentace se řídí stylem MSDN s obsah, index, API třídní dokumentace a vlastní témata, křížové odkazy, Vyhledávání, IntelliSense a F1 kontextová nápověda.[2]
Vzhledem k tomu, že kompilátor má přístup k projektu Visual Studio, může obsahovat také zdrojový kód a třídní diagramy (soubory .cd) v dokumentaci. Projekty lze dokumentovat samostatně nebo lze generovat jedinou dokumentaci pro celé řešení.[3]
Formát výstupní dokumentace je konfigurovatelný. Předdefinované formáty jsou:
Výstup lze lokalizovat a některé jazyky jsou již zahrnuty.[4]
Editor komentářů
VSdocman umí číst Komentáře XML z zdrojový kód. Ruční úprava komentářů může být obtížný úkol, který proto obsahuje WYSIWYG editor komentářů, který pomáhá psát komentáře XML a vlastní témata. Přímo do zdrojového kódu je možné vložit tabulky, seznamy, obrázky, diagramy tříd, odkazy a další formátování. Na základě typu člena kódu může uživatel zadat výchozí komentář. Tento komentář bude automaticky přidán, když uživatel přidá nebo upraví komentář poprvé. Například pro booleovské vlastnosti se automaticky generuje souhrnný text „Získá nebo nastaví hodnotu označující, zda ...“.[5]
Dějiny
Původně byl VSdocman pojmenován VBdocman .NET, protože se vyvinul z VBdocman. VBdocman .NET podporuje pouze Visual Basic .NET. Po přidání podpory pro C # v roce 2006 byl přejmenován na VSdocman.[6]
Viz také
Reference
externí odkazy
 | Tento programovací nástroj související článek je a pahýl. Wikipedii můžete pomoci pomocí rozšiřovat to. |