Results 1 to 8 of 8

Thread: Documentation tool

  1. #1

    Documentation tool

    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?
    blog: http://alexionne.blogspot.com/

  2. #2

    Documentation tool

    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

  3. #3
    Legendary Member NecroDOME's Avatar
    Join Date
    Mar 2004
    Location
    The Netherlands, Eindhoven
    Posts
    1,059
    NecroSOFT - End of line -

  4. #4
    Legendary Member cairnswm's Avatar
    Join Date
    Nov 2002
    Location
    Randburg, South Africa
    Posts
    1,537

    Documentation tool

    I found a product called Pascal Doc that I modified slightly. We use this at work to document our projects
    William Cairns
    My Games: http://www.cairnsgames.co.za (Currently very inactive)
    MyOnline Games: http://TheGameDeveloper.co.za (Currently very inactive)

  5. #5
    Co-Founder / PGD Elder WILL's Avatar
    Join Date
    Apr 2003
    Location
    Canada
    Posts
    6,107
    Blog Entries
    25

    Documentation tool

    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.
    Jason McMillen
    Pascal Game Development
    Co-Founder





  6. #6

    Documentation tool

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

  7. #7

    Documentation tool

    Thanx everyone for your answers! This will surely help
    blog: http://alexionne.blogspot.com/

  8. #8

    Documentation tool

    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.

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •