[Phpwebsite-developers] Comments in source files

[Karsten D. <k.d...@tu...>]

Hi all!

I noticed that people start to put comments into the code. Good! Notably
adam put a lot of comments into the source about a week ago.

But... I think it would be better to use hphdoc comments. For those not
familiar with that: phpdoc is a project to automaticaly generate class
and/or function documentation from source code. It is inspired by the
javadoc tool, which is (anyone who used it will probably agree) just great.

phpdoc is now part of PEAR so it can be found at cvs.php.net or in your
distribution (not sure about that, though) of PHP. It's main website is
www.phpdoc.de, which is fortunately available in english, despite the de cc.

In short: I would be pleased to see phpdoc comments in the source files.
maybe this will make generating an always up to date source documentation
possible. The way I am doing/trying this now is a bit awkward :-/

Regards,
Karsten
--=20
Why do we have to hide from the police, daddy?
Because we use emacs, son. They use vi.
-----------------------------
mailto:k.d...@tu...=20
docs: http://www.k-fish.de/krabutzig/phpwebsite/
gpg: http://www.k-fish.de/mykeys.gpg