Documentation tool

**alexione** · 08-07-2006, 07:21 PM

Hi, all!

Few days ago (actually, on Wednesday, 5.7.), I've defended my Final Thesis and finished my high education

One really big issue about the project I worked on (and I still work on it), is that, except in-code comments and txt-files, it doesn't have separate documentation even though it has more than 25k lines of code. Does anyone use some special tool to keep documentation of a large project?

**dmantione** · 08-07-2006, 07:58 PM

Use fpdoc. We use it to document all our libraries and there is absolutely nothing that beats it.

http://community.freepascal.org:1000...ml/fpdoc/fpdoc

**NecroDOME** · 09-07-2006, 01:30 PM

http://dephicodetodoc.sourceforge.net/

**cairnswm** · 09-07-2006, 06:01 PM

I found a product called Pascal Doc that I modified slightly. We use this at work to document our projects

**WILL** · 09-07-2006, 08:35 PM

Lazarus comes with it's own documentation tool. LazDoc I think it's called. Haven't worked with it too much, but it looks handy.

**tux** · 09-07-2006, 09:05 PM

I've tried out TwinText, its quite good but not free (although the cheapest of all the commercial ones ive seen)

**alexione** · 09-07-2006, 10:06 PM

Thanx everyone for your answers! This will surely help

**dmantione** · 09-07-2006, 10:09 PM

Lazdoc is a frontend to fpdoc. The difference between fpdoc and for example Pasdoc is that fpdoc uses an external XML file for the documentation, while Pasdoc reads documentation from the comments.

While reading documentation from the comments might look attractive at the first sight, it does not do for quality documentation. First, there is no space in the source code for verbose documentation, but more important, many ingredients for good documentation are not possible. For example it is not really doable to specify hyperlinks or example programs in source code comments.