Re: Re: [PEPr] +1 for Configuration::Config_Lite

On 2011-01-25 13:52, Patrick E. wrote:

hi, thanks for the vote and hints :) @Michael Gauthier Should i also provide examples in the docblock?

Small examples are acceptable, but not required for docblocks. I usually have one or two examples in class docs, but not in method docs. The most important thing is to describe the intention of the method. To get examples to look proper in the final generated documentation use something like: /** * Foos the bar * * For example: * <code> * <?php * $mainFoo->foo($baz); * ?> * </code> * * @param $foo integer foo. * * @return void */ Cheers, Mike