|
Posted by John Bokma on 10/06/86 11:38
news@celticbear.com wrote:
> I've been working someplace for a year now where a previous employee
> spent 4 years writing hundreds of pages and tens of thousands (perhaps
> hundreds of thousands) of lines of code in PHP.
How well documented is the PHP. It might be quite rewarding to have a tool
that is able to extract the comments out of it, and make documentation
automatically. (aka javadoc) I am sure that those tools are available.
<http://www.google.com/search?q=javadoc%20for%20php>
> And I and a newer employee have pounded our heads on various functions
> and pages and includes... and it just occured to me to start making a
> wiki for the site!
I would start with extending the documentation of the PHP stuff, and
transforming it into something that can be used with the aforementioned
tool. Also the good old plain paper for drawing relations between things
might be a good idea.
(I have some experience, once I was asked to maintain 650+ modules of
Perl)
> As we work on pages and components we can add to the wiki and be able
> to search and find tips and tricks that were before commited only to
> memory or scratch paper.
The major advantage of documenting the source and autogenerating the
documentation is that you have the documentation in one place: the source.
If you run the aforementioned tool. And the amazing this is: it's a wiki.
You edit the pages in your editor by loading the source :-D
And of course you use something like subversion for version control.
--
John Experienced (web) developer: http://castleamber.com/
Perl SEO tools: http://johnbokma.com/perl/
NEW ----> Textpad reference card (pdf): http://johnbokma.com/textpad/
Navigation:
[Reply to this message]
|