[VS2008] Documenteren

[Verwijderd]

Ik ben betrokken bij een Open-Source applicatie (www.mapwindow.org) die ontwikkeld wordt met VS2008 (C++, C#, VB.NET).
De applicatie bestaat uit een ActiveX, een groot aantal dlls en een exe.
De exe heeft een plug-in architectuur en de ActiveX kun je ook in je eigen applicatie gebruiken.

Voor documentatie gebruiken we een wiki, maar het blijkt dat de documentatie erg achter loopt bij de code ontwikkelingen.
Zoals zo vaak is documenteren niet de meest favoriete bezigheid van een ontwikkelaar

We zijn dan ook op zoek naar een manier om dat eenvoudiger en eenduidiger te maken. De code zelf wordt wel goed gedocumenteerd.
Nu zijn we Sandcastle en Docproject aan het bekijken, maar die integreren niet met de bestaande wiki.

Nu is mijn vraag, hoe documenteren jullie? Het gaat dus niet zozeer om de gebruikers documentatie, maar om de documentatie hoe de plug-in architectuur en de ActiveX te gebruiken.
Ter verduidelijking twee links als voorbeeld hoe de wiki nu werkt:
http://www.mapwindow.org/...hp/MapWinGIS:AxMap_Redraw
http://www.mapwindow.org/...oProc_Developer%27s_Guide

[H!GHGuY]

Misschien is NDOC wel iets voor je?
http://ndoc.sourceforge.net/

Het integreert netjes met je code comments en je kan er een .CHM-style manual mee maken.

[ Voor 41% gewijzigd door H!GHGuY op 02-11-2009 09:42 ]

[Woy]

Met SandCastle kun je toch gewoon zelf templates maken? Dan kan je toch gewoon een template maken die aansluit bij je Wiki, en dan naast je Wiki de API documentatie zetten. Het lijkt me immers niet wenselijk dat er in de API docs alsnog wijzigingen aangebracht worden, die worden immers toch wel overschreven als er een nieuwe gegenereerd word.

Het gaat dus niet zozeer om de gebruikers documentatie, maar om de documentatie hoe de plug-in architectuur en de ActiveX te gebruiken

Voor de architectuur zul je denk ik toch handmatig wat bij moeten werken, die is immers lastig uit de code te genereren. Maar het lijkt me ook dat je basis architectuur niet zo vaak veranderd, dat dat een probleem moet vormen.

[ Voor 35% gewijzigd door Woy op 02-11-2009 09:47 ]

[Brakkie]

H!GHGuY schreef op maandag 02 november 2009 @ 09:42:
Misschien is NDOC wel iets voor je?
http://ndoc.sourceforge.net/

Het integreert netjes met je code comments en je kan er een .CHM-style manual mee maken.

Werkt die laatste release uit 2005 nog wel goed met vs2008?

[Verwijderd]

Bedankt allemaal.
Ik zal NDoc ook eens goed bekijken, ook al is dat wel een 'oudje'.
Ik had nog niet gezien dat je met SandCastle ook wiki pagina's kunt maken door een eigen template te maken. Dat zal ik ook uitproberen.

Inderdaad zal de API documentatie niet veel wijzigen, ook al zijn er de afgelopen maanden wel veel nieuwe functies toegevoegd. Maar we willen ook graag voorbeeldcode er bij zetten en dan moet je, volgens mij, elke pagina 1 voor 1 aanpassen.
Voor de plug-in architectuur willen we een aantal dlls documenteren, die wijzigen ook niet zo vaak, maar nieuwe functies worden wel regelmatig toegevoegd. En ook hier willen we voorbeeldcode toevoegen.
Ik zal SandCastle eerst wat beter bestuderen, misschien dat ze daar ook een oplossing voor hebben.

[Sebazzz]

http://sourceforge.net/projects/ndocplus/
Deze is een voortzetting van het originele ndoc project. Ik vind het erg fijn werken, het genereert nette documentatie in MSDN lite stijl.

[Matis]

Ikzelf heb hele goede ervaringen met Doxygen, http://www.stack.nl/~dimitri/doxygen/

Met de juiste instellingen / parameters kun je compleet klikbaar klassediagram + omschrijving maken

Je kunt met trac http://trac.edgewall.org/ (dat is een SVN-monitor tool) ook Wiki's genereren + bijhouden.

[ Voor 22% gewijzigd door Matis op 02-11-2009 10:20 ]

[jp]

Doxygen lijkt geen VB.Net te ondersteunen, een eis van de TS

[Matis]

jp schreef op dinsdag 03 november 2009 @ 09:41:
Doxygen lijkt geen VB.Net te ondersteunen, een eis van de TS

Daarom zijn er ook:

VBdocman
Document! X
VBDoc
VB.DOC
VBDoxygen

[ Voor 37% gewijzigd door Matis op 03-11-2009 09:43 ]

[CMG]

Microsoft was paar jaar geleden met een project met de code naam 'Sandcastle', is daar al wat uitgekomen wellicht?

[Sebazzz]

Voor mij is het meer een Aircastle Ik vind Ndoc+ tien keer makkelijker in gebruik.

[RobIII]

CMG schreef op dinsdag 03 november 2009 @ 23:38:
Microsoft was paar jaar geleden met een project met de code naam 'Sandcastle', is daar al wat uitgekomen wellicht?

http://www.codeplex.com/Sandcastle maar wel effe wakker worden he?
Ik gebruik 't en 't bevalt prima.

[ Voor 20% gewijzigd door RobIII op 04-11-2009 09:23 ]

[CMG]

RobIII schreef op woensdag 04 november 2009 @ 09:23:
[...]

http://www.codeplex.com/Sandcastle maar wel effe wakker worden he?
Ik gebruik 't en 't bevalt prima.

Wow, ik ben echt blind sorry.