Login | Register
My pages Projects Community openCollabNet

Discussions > dev > Re: [propel-dev] Coding Standards

propel
Discussion topic

Back to topic list

Re: [propel-dev] Coding Standards

Reply

Author Cameron Brunner <cameron dot brunner at gmail dot com>
Full name Cameron Brunner <cameron dot brunner at gmail dot com>
Date 2006-09-21 07:25:26 PDT
Message On 9/22/06, Hans Lellelid <hans at velum dot net> wrote:
> Hi,
>
> Cameron Brunner wrote:
> > On 9/21/06, Ron Rademaker <r.rademaker@virt​ualbuilding.nl> wrote:
> >> A few thoughts:
> >>
> >> - On the comments before a function. How about always adding a @since
> >> with the date the function was added and an @author who added the
> >> function (makes finding the appropriate person for bugs / questions /
> >> suggestions a lot easier than going through svn logs)
> >
> > svn blame, but agreed, author for the class and then if the author
> > isnt the same for the function then it should be on the function as
> > well, same rules for since
>
> We can also get rid of Torque authors at this point (1.3 onward). I
> wanted to attribute the origins of the code as appropriate, but the
> classes have been reworked a number of times now -- so they'll probably
> be bearing little resemblance to any Torque code from here on out.
>
> >> - Personally, I like if styles like this:
> >>
> >> if ($something)
> >> return "something";
> >>
> >> Two lined if's without {} that is, current coding standards don't tell
> >> me if I can use them.
> >
> > ug, no, i HATE this, people rely on it for more than 1 line of code
> > below the if too often, we should blow this out of existance!
>
> Yeah, I tend to agree. My personal preference is a hybrid approach
> where functions are like
>
> public function myfunc()
> {
>
> }
>
> but if-statements are on same line:
>
> if ($foo === true) {
>
> } elseif () {
>
> } else {
>
> }
>
> But for the same of consistency, I'm willing to give up my functions
> with { opening on their own line :)
>
> For simplicity, we may just wish to adopt the PEAR coding standards,
> since they are ubiquitous in the PHP world.

Against just following the heard and using PEAR standards

switch ( $blah ) {

    case 'blah':

        echo 'asdf';
        break;

}

indenting the case is something i prefer over not for a start

$long_variable example... well, we could follow that but... painful for nothing?

These are just what I like and find easy to follow and read without
having to think much when i jump into new code. Mostly its just about
not being lazy and getting over typing a few extra lines to save
headaches maintaining.


Cameron

« Previous message in topic | 11 of 22 | Next message in topic »

Messages

Show all messages in topic

Coding Standards Cameron Brunner <cameron dot brunner at gmail dot com> Cameron Brunner <cameron dot brunner at gmail dot com> 2006-09-20 21:21:50 PDT
     Re: [propel-dev] Coding Standards hlellelid Hans Lellelid 2006-09-21 05:44:54 PDT
         Re: [propel-dev] Coding Standards Cameron Brunner <cameron dot brunner at gmail dot com> Cameron Brunner <cameron dot brunner at gmail dot com> 2006-09-21 06:03:09 PDT
             Re: [propel-dev] Coding Standards hlellelid Hans Lellelid 2006-09-21 06:12:47 PDT
                 Re: [propel-dev] Coding Standards Cameron Brunner <cameron dot brunner at gmail dot com> Cameron Brunner <cameron dot brunner at gmail dot com> 2006-09-21 06:40:12 PDT
                     Re: [propel-dev] Coding Standards Ron Rademaker <r dot rademaker at virtualbuilding dot nl> Ron Rademaker <r dot rademaker at virtualbuilding dot nl> 2006-09-21 06:47:09 PDT
                         Re: [propel-dev] Coding Standards Cameron Brunner <cameron dot brunner at gmail dot com> Cameron Brunner <cameron dot brunner at gmail dot com> 2006-09-21 06:53:32 PDT
                             Re: [propel-dev] Coding Standards Ron Rademaker <r dot rademaker at virtualbuilding dot nl> Ron Rademaker <r dot rademaker at virtualbuilding dot nl> 2006-09-21 06:58:56 PDT
                                 Re: [propel-dev] Coding Standards =?UTF-8?B?RXZlbiBBbmRyw6kgRmlza3Zpaw==?= <even at lynweb dot no> =?UTF-8?B?RXZlbiBBbmRyw6kgRmlza3Zpaw==?= <even at lynweb dot no> 2006-09-21 07:02:34 PDT
                             Re: [propel-dev] Coding Standards hlellelid Hans Lellelid 2006-09-21 07:03:20 PDT
                                 Re: [propel-dev] Coding Standards Cameron Brunner <cameron dot brunner at gmail dot com> Cameron Brunner <cameron dot brunner at gmail dot com> 2006-09-21 07:25:26 PDT
                                     Re: [propel-dev] Coding Standards hlellelid Hans Lellelid 2006-09-21 07:27:23 PDT
                                         Re: [propel-dev] Coding Standards =?UTF-8?B?RXZlbiBBbmRyw6kgRmlza3Zpaw==?= <even at lynweb dot no> =?UTF-8?B?RXZlbiBBbmRyw6kgRmlza3Zpaw==?= <even at lynweb dot no> 2006-09-21 07:31:05 PDT
                                             Re: [propel-dev] Coding Standards Alan Pinstein <apinstein at mac dot com> Alan Pinstein <apinstein at mac dot com> 2006-09-21 07:36:02 PDT
                                 Re: [propel-dev] Coding Standards =?ISO-8859-1?Q?David_Z=FClke?= <dz at bitxtender dot com> =?ISO-8859-1?Q?David_Z=FClke?= <dz at bitxtender dot com> 2006-09-23 07:18:45 PDT
                                     Re: [propel-dev] Coding Standards hlellelid Hans Lellelid 2006-09-23 07:22:03 PDT
                                         Re: [propel-dev] Coding Standards =?ISO-8859-1?Q?David_Z=FClke?= <dz at bitxtender dot com> =?ISO-8859-1?Q?David_Z=FClke?= <dz at bitxtender dot com> 2006-09-23 07:43:10 PDT
                                 Re: [propel-dev] Coding Standards Carl Parrish <cparrish at pcl-consulting dot com> Carl Parrish <cparrish at pcl-consulting dot com> 2006-12-06 07:54:51 PST
                         Re: [propel-dev] Coding Standards Alan Pinstein <apinstein at mac dot com> Alan Pinstein <apinstein at mac dot com> 2006-09-21 07:33:25 PDT
                             Re: [propel-dev] Coding Standards hlellelid Hans Lellelid 2006-09-21 07:42:40 PDT
                                 Re: [propel-dev] Coding Standards Ron Rademaker <r dot rademaker at virtualbuilding dot nl> Ron Rademaker <r dot rademaker at virtualbuilding dot nl> 2006-09-21 07:46:43 PDT
         Re: [propel-dev] Coding Standards Alan Pinstein <apinstein at mac dot com> Alan Pinstein <apinstein at mac dot com> 2006-09-21 07:38:56 PDT
Messages per page: