[Phpmyadmin-devel] coding standards for phpmyadmin

[Mohamed Ashraf]

On Sunday, September 1, 2013 at 2:52 PM, Dieter Adriaenssens wrote:

> 2013/9/1 Mohamed Ashraf <mohamed.ashraf.213 at gmail.com>:
> > 
> > On Sun, Sep 1, 2013 at 2:11 PM, Dieter Adriaenssens
> > <dieter.adriaenssens at gmail.com> wrote:
> > > 
> > > 2013/8/31 Mohamed Ashraf <mohamed.ashraf.213 at gmail.com>:
> > > > I was looking but didnt find the phpma coding standard for things like
> > > > docs,
> > > > function names and conventions.
> > > > 
> > > > The question I was looking for was the function name convention for
> > > > library
> > > > function since I saw two standards being followed in the codebase and I
> > > > am
> > > > not sure which is correct.
> > > > 
> > > 
> > > 
> > > If I'm not mistaken, PHP library methods should have this form
> > > (following the PEAR standard) :
> > > 
> > > PMA_someFunction()
> > > 
> > > - PMA prefix
> > > - camelCasing
> > > 
> > > What other kind of standard did you find?
> > PMA_generate_common_hidden_inputs
> > I did not know if we are using underscores or camel casing. I looked at the
> > pear standard and found out about the rest of the conventions for code. but
> > not the documentation convention.
> > 
> 
> 
> Yes, camelCase. But phpMyAdmin has a history of 15 years and
> refactoring is still ongoing, so you might find some other styles as
> well.
> 
> > for example if a function returns two things how is that represented in the
> > documentation.
> > 
> 
> 
> I don't understand what you mean? A function can have only one return value.
> Do you mean that a function returns an array? Or an object? Or has a
> 'byReference' parameter? Or sets a global variable?
> 
> 

The array way. How would that be documented. 
> 
> -- 
> Kind regards,
> 
> Dieter Adriaenssens
> 
> ------------------------------------------------------------------------------
> Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!
> Discover the easy way to master current and previous Microsoft technologies
> and advance your career. Get an incredible 1,500+ hours of step-by-step
> tutorial videos with LearnDevNow. Subscribe today and save!
> http://pubads.g.doubleclick.net/gampad/clk?id=58040911&iu=/4140/ostg.clktrk
> _______________________________________________
> Phpmyadmin-devel mailing list
> Phpmyadmin-devel at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel
> 
> 


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.phpmyadmin.net/pipermail/developers/attachments/20130901/0bde1bbf/attachment.html>