Re: experimental features?
| From: | Raphaël Gertz | Date: | Wed, 12 Jul 2006 17:27:19 +0000 |
| Subject: | Re: experimental features? | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-43440@lists.php.net to get a copy of this message | ||
> Le mercredi 12 juillet 2006 17:52, Lorenzo Alberton a écrit :
> Hi Lukas,
>
> > I am wondering how I should deal with new experimental features in MDB2?
> > Am I allowed to mark a feature as experimental in the phpdoc comments
> > and the changelog?
>
> I think so
>
> > In which case I am allowed to later change the API,
> > eventhough the feature was released as part of a stable version?
>
> as long as you clearly state that,
> an "@experimental" feature is by definition
> subject to changes.
>
When we are on the PEAR documentation of code...
Have you somewhere a full template that describe all the option and verbose
level to apply ?
Something like that, but complete (all option, param, etc...) :
<?php
/*
* The example class
* @access public
* @version 0.0.1
* {{{
*/
class example
{
/*
* The funexample function
* @access public
* @param parexample
*/
public funexample($parexample)
{
//do something
}
}
/*
* }}}
*/
?>
I already looked some example, but a single example will be more usefull than
small limited (incomplete) example that I found on the net
Attachment: [application/pgp-signature]
Attachment: [application/pgp-signature]