Re: Class Tar : first code review

----- Original Message ----- From: "Tomas V.V.Cox" <cox@idecnet.com> To: "Vincent Blavet" <vincent@blavet.net> Cc: <pear-dev@lists.php.net> Sent: Thursday, August 09, 2001 10:35 AM Subject: Re: [PEAR-DEV] Class Tar : first code review > > Vincent Blavet wrote: > > > > Hello, > > > > I send (attached) the first version of a tar class which can be > > usefull for PEAR project. > > Wonderful work! :) Thanks > > > 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)) > OK I will correct the typos > Somethings to add to the TODO: > > *support for Windows What do you mean by "support for Windows" ? I am developping on Win 2000 and Win 98 ... Web server is Apache. > > > - 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. > I will do that, but I still fail to access the CVS ... Thanks for the feedback Vincent > > - anything you think can help me ... > > anything you think can help you... :) > > > Tomas V.V.Cox > > -- > PEAR Development Mailing List (http://pear.php.net/) > To unsubscribe, e-mail: pear-dev-unsubscribe@lists.php.net > For additional commands, e-mail: pear-dev-help@lists.php.net > To contact the list administrators, e-mail: php-list-admin@lists.php.net > >