Documenting functions (A97/SR2)

Topic

New Reply

Can anyone make any recommendations on any software packages to create documentation & help files from tags in comments in the code?
– I’ve seen both DocumentX and VBDocMan.
Both seem pretty useful, but the big plus for DocumentX is it works with VBA as well as VB code. VBDocMan is a lot cheaper, e.g. single licence $58, versus $311 for DocumentX , and even better a site licence is only $419, so the saving for three of us on one site, and the dozen on the other site will be considerable. Of the two, I think the DocumentX output looks better.
Are there any other products, or a simpler/better way to produce the documentation
(I’ve copied this over VB/VBA, as it’s really Access VBA that I want to work with)

Reply | Quote

Replies

I don’t see how you could create help files from tags in code. The help files are intended to explain stuff in the user interface, not in the code. I certainly wouldn’t want to have to embed all my help documentation in my code as comments. Nor do I see what kind of documentation you would expect to build by relying on the comments in your code. Perhaps if you explain what exactly you want to create, someone can suggest another product.

Reply | Quote

Sorry my terminology was incorrect.
I don’t mean Help files, but to quote the DocumentX site, Document! X automates the process of creating and maintaining documentation for Microsoft .NET Assemblies, Visual Basic / VBA / VB.NET source code, Databases, compiled COM components and Type libraries.
In my case, we have various functions that we’ve write for use in our Access reports, e.g. specific formatting. Originally only used internally, but users wanted “something”, so they’ve been given a compiled MDE so they can add a reference in their database and thus get the functions. Now I’d like to have a chm with details of each function, similar to the DocumentX http://www.vbhtmlhelp.co.uk/products/documentx.asp%5B/url%5D
It uses metatags in the actual code comments to create the chm

Reply | Quote

It seems to me that if you’re going to have to go back and insert comments with specific tags in them in order to generate a document automatically, you might was well create the comments directly in the source document for the help file.

Reply | Quote

Yes maybe, but I’ll be adding new functions, so I want to have one master from which I can generate the MDE and the documentation
– I just know that I’ll not keep the documentation up-to-date if it’s separate from the actual code

Reply | Quote