dotNETportal.cz

Ahoj, prosím o radu zkušenějších v čem děláte technickou dokumentaci ke kódu. Rozhodl jsem se dát si svoje zdrojáky do pořádku a chtěl bych je vybavit technickou dokumentací. Můžete mi poradit nějaký osvědčený software (ať už jako samostatný program nebo addon do Visual Studia)?

Jediným mým požadavkem je aby to umělo graficky vyjádřit vzájemné vazby tříd, myslím si že to je velmi užitečné.

Příjemným bonusem by bylo kdyby to byl freeware, ale není to podmínka. Při hledání jsem narazil na NDoc, ale bohužel se mi nepodařilo stáhnout verzi pro Visual Basic.

Díky za rady

Doporučuji GhostDoc

Záleží na tom, co přesně potřebujete. Vkládat dokumentaci ke kódu a graficky zobrazovat vazby tříd umí samotné Visual Studio bez nutnosti doplňků třetích stran. GhostDoc (základní verze zdarma, Pro verze za prachy) je dobrý na to, že umí okomentovat členy odvozené třídy na základě základní třídy nebo rozhraní, takže není nutné to psát 2x nebo vůbec. Pokud potřebujete sestavit dokumentaci (*.chm soubory) ve stylu MSDN z vytvořených XML souborů, k tomu slouží Sandcastle (zdarma).

Dobrý den,

děkuji za reakce. GhostDoce (ve free verzi) nějaký čas používám, ale pouze pro generování XML komentářů u metod a property tříd. Prozkoumám ještě co umí navíc placená verze.

O diagramech ve Visual Studiu vím, ale nepřišel jsem na to jak vyjádřit graficky vazby mezi třídama tam, kde se nevytvoří automaticky. Zdědil jsem pár projektů, kde jednotlivé třídy reprezentují jednotlivé tabulky v databázi (to že to je objektově blbě je věc druhá) a já bych třeba potřeboval naznačit že tam je vazba PK -> FK.

Ještě vyzkouším ten Sandcastle, chtěl bych právě mít dokumentaci uloženou někde mimo projekt a toto vypadá že by to mohlo být to pravé.