RE: [Phpgroupware-developers] documentation

[Kai Hofmann]

Hi Sigurd,

> Some time ago there was a discussion on how to document the 
> code - I can't 
> really remember if there was a conclusion.
> Is the Pear version of PhpDocumentor a good alternative? (or 
> HeaderDoc? - or 
> the wiki?).

For API (inline) documentation phpdocumentator (http://www.phpdoc.org/)
should be used.
For other kind of documentation, like install docs, how tos etc.
the phpgw wiki is the right place.

For the phpdoc's I have already written a script (that has not yet
applied), which can extract these kind of docs every night from cvs.

> Is performance affected by inline documentation when using a 
> precompiler as  mmcache?

mmcache will always speed up performance, because it precompiles php 
scripts written in ascii to an internal presentation that is faster,
because it does not need again scanning and parsing.
Think of it like java vs. byte-code.

I have not found that inline docs (comments) or tabs vs. spaces
will influence the performance of php in a way you can feel or
even measure.
Nearly all performance problems come from bad code/architecture that does
things like
reading the same value for every http request from the database (instead of
caching it via shared memory).

On the other hand there are toold with which you can strip comments from
the code for your runtime environment. So you should not worry about
performance when using inline docs.

Greetings

   Kai/PowerStat





-- 
*****    Open Source und Linux im professionellen Einsatz    *****
**  komplexe Mailserver, Groupware, Office: sprechen Sie uns an **
Dipl.-Inform. Kai Hofmann                    Team Softwarelösungen
pro|business AG, EXPO Plaza 1 (Deutscher Pavillon), 30539 Hannover
E-Mail: address@hidden,   Tel.: 0511/60066-332, Fax: -355
WWW: http://www.probusiness.de/