Re: Class Tar : first code review

From: Date: Thu, 09 Aug 2001 08:35:23 +0000
Subject: Re: Class Tar : first code review
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-1329@lists.php.net to get a copy of this message
> Vincent Blavet wrote: > > Hello, > > I send (attached) the first version of a tar class which can be > usefull for PEAR project. Wonderful work! :) > I'm waiting for your advices on the following points : > - Coding Standard, I see some style/typo: * brackets (except for class and function): if ($foo) { } else { } * private method names should be named _foo() instead of privFoo() * "else if" => "elseif" * extra comments. Is very nice to have comment for hard pieces of code, but having too much comments dificult the readability of the code. ie: // ----- Look if the $filelist is really an array if (is_array($filelist)) Somethings to add to the TODO: *support for Windows > - How to document the methods ? : Directly in the code (comments in a > header before each method) ? We use PHPDoc to document the API directly in the code. You can see examples in the API documentation inside PEAR.php and the full doc in http://phpdoc.de > - Where to put this class in the PEAR project, I think pear/File is the right directory for that and the class name File_Tar. > - Waiting for access to CVS (Stig ?) Perhaps when you get access, you could upload the class to the Experimental dir so you and us could test/work on it. > - anything you think can help me ... anything you think can help you... :) Tomas V.V.Cox

« previous php.pear.dev (#1329) next »