Suttree.com: Casual Games, Social Software

Read more at the weblog »

Auto-documenter

This perl script strips comments from the files passed to it, and creates documentation by association the comments with the object, method or function where they are relevant. I use it to quickly document large PHP or Perl codebases that I need to extend. Having worked on a number of different procjects, this is something that I have found to be *very* useful. It won't give you intimate knowledge of a codebase, but it will give you a good overview in a short space of time.

Usage
$ ./doco.pl /path/to/file and it will put the documentation for that file in the output/ folder.

Installation
First, decompress the tar.gz file into any directory and then just run doco.pl as specified above.

Download
Auto-document for Perl and PHP can be downloaded from here
Download Auto-document

Version 2
Version 0.5 is being developed right now, so flames, feedback and questions can be directed to me, here.

Suttree Beatniks with better clothing, brought to you by Duncan Gough. About Archives Casual Game Dev Code Disclaimer EcoLocal Music Knows PMOG Tumblee
Links for Monday, March 22nd, 2010