[PHP] dev style guide

[Jay Blanchard]

[snip]
They use the One True Brace Style,
which is encouraging:

function fooFunction($arg1, $arg2 = '')
{
if (condition) {
statement;
}
return $val;
}
[/snip]

At the risk of starting a flame/religious/holy war I find the One True
Brace style to have some inconsistency if it is as above. The 'function'
does not open the curly brace at the EOL, but the 'if' does. I also
mentioned me being and old-schooler earlier today but the rules that we
use in our (current) group always place the opening curly at the EOL.
Also, we do not allow ternary notation. We encourage Hungarian notation,
but do not require it if the documentation is clear.

HTH!

[Mike Migurski]

>At the risk of starting a flame/religious/holy war I find the One True

>Brace style to have some inconsistency if it is as above. The 'function'
>does not open the curly brace at the EOL, but the 'if' does.

Yeah, that's pretty much the definition of the OTBS. :)

I'm not sure why I find it so natural, but basically it acknowledges that
function definitions are fundamentally different (in usage and meaning)
than other code blocks. I like this.

>I also mentioned me being and old-schooler earlier today but the rules
>that we use in our (current) group always place the opening curly at the
>EOL. Also, we do not allow ternary notation.

Personally, I use ternary notation a lot, but I try to use it thusly:

(condition
? statement 1
: statement 2)

The line breaks make it easier to see what's going on.

I don't think it really matters what standard you use, as long as you
*have one* and everyone in your group agrees that it's a comfortable fit,
which paradoxically seems to converge on something like what PEAR uses
anyway.

Anecdote:
At one time, a member of our group decided (on their own) that the coding
style should automatically prefer printf() constructions to double-quoted
variable interpretation, and that it should be word-wrapped to fit within
his 80-char vim terminal. An autoconversion script was written, files were
drastically modified to conform, and then subsequently committed to CVS.
This is not a proper way to go about implementing a coding standard. :P

---------------------------------------------------------------------
michal migurski- contact info and pgp key:
sf/ca [url]http://mike.teczno.com/contact.html[/url]

[Chris W. Parker]

Jay Blanchard <mailto:jay.blanchard@niicommunications.com>
on Tuesday, August 05, 2003 1:23 PM said:

> We
> encourage Hungarian notation, but do not require it if the
> documentation is clear.

Ahhh.... /Hungarian/ notation. Now that makes sense. I *thought* there
was something funny about "polish notation" (which as I've found out is
a certain way of expressing mathematical equations [iirc]).

I've found a few articles on Hungarian notation but none of them have
been all that great. Real wordy and without good examples. Do you have
any examples/articles to contribute?


c.

[Jswalter]

> -----Original Message-----

> From: Chris W. Parker [mailto:cparker@swatgear.com]
> Sent: Tuesday, August 05, 2003 4:33 PM
> To: Jay Blanchard; Mike Migurski; jsWalter
> Cc: [email]php-general@lists.php.net[/email]
> Subject: RE: [PHP] dev style guide

> Ahhh.... /Hungarian/ notation. Now that makes sense. I *thought* there
> was something funny about "polish notation" (which as I've found out is
> a certain way of expressing mathematical equations [iirc]).

OK, OK, my math geek-ness reared its ugly head.

Hungarian notation is waht I shoulfd have said.

;)

> I've found a few articles on Hungarian notation but none of them have
> been all that great. Real wordy and without good examples. Do you have
> any examples/articles to contribute?

This is what I found on the issue around the 'net...

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnvsgen/htm
l/hunganotat.asp

http://support.microsoft.com/default.aspx?scid=http://support.microsoft.com:
80/support/kb/articles/Q173/7/38.ASP&NoWebContent=1

http://www.gregleg.com/oldHome/hungarian.html

this one is short and sweet...

http://www4.ncsu.edu:8030/~moriedl/projects/hungarian/

walter

[Jay Blanchard]

[snip]
I've found a few articles on Hungarian notation but none of them have
been all that great. Real wordy and without good examples. Do you have
any examples/articles to contribute?
[/snip]

There is a lot to go on out there
[url]http://www.google.com/search?hl=en&ie=UTF-8&oe=UTF-8&q=Hungarian+notatio[/url]
n

We have agreed on cetain types (strings are strFoo, integers are intFoo,
doubles are dblFoo, etc.) and allow for other descriptive notation where
standard terms do not work.

HTH

[SLanger@spirit21.de]

Just a remark but isn't it pointless to use Hungariannotation in a
language that is by default typeless???

Regards
Stefan Langer

[Jay Blanchard]

[snip]
Just a remark but isn't it pointless to use Hungariannotation in a
language that is by default typeless???
[/snip]

We use it becuase we have a group of programmers, so the notation makes
it easier for one in the group to understand the intention of another in
the group. The notation also helps to clear up any casting issues that
may arise. [url]http://us2.php.net/language.types.type-juggling[/url]

[Cpt John W. Holmes]

From: <SLanger@spirit21.de>

> Just a remark but isn't it pointless to use Hungariannotation in a
> language that is by default typeless???

I would think that it would be the reason why you WOULD want to use
Hungarian notation (not that I do, though).

Even though you can take nVar and concatinate it into a string, should you?
Maybe you should first cast it to a string, then concatinate... right?

Using the notation would mean that'd you'd know what the varaible was
intended to hold when it was created, even though it can be juggled into
another type by PHP rather easily.

---John Holmes...

[Miles Thompson]

At 11:27 AM 8/6/2003 -0500, Jay Blanchard wrote:

>[snip]
>Just a remark but isn't it pointless to use Hungariannotation in a
>language that is by default typeless???
>[/snip]
>
>We use it becuase we have a group of programmers, so the notation makes
>it easier for one in the group to understand the intention of another in
>the group. The notation also helps to clear up any casting issues that
>may arise. [url]http://us2.php.net/language.types.type-juggling[/url]

And it helps when you get back up to speed when you revisit a project after
a few months.
Use of Hungarian notation has been a bit of a religious issue; use what
works and use it consistently.

Of course, if you come from the Flash world, it's likely a postfix (ugly
word!) rather than prefix.

Cheers - Miles

[Phillip Blancher]

Actually the word is Suffix not postfix... Prefix and Suffix.


--
Best Regards, Phil

Phillip Blancher
Web Developer & Lead Graphic Designer
< [url]http://www.ontarioweb.ca[/url] > 1-866-209-0349
< [email]phil@ontarioweb.ca[/email] >
----- Original Message -----
From: "Miles Thompson" <milesthompson@ns.sympatico.ca>
To: <php-general@lists.php.net>
Sent: Wednesday, August 06, 2003 2:37 PM
Subject: RE: [PHP] dev style guide

> At 11:27 AM 8/6/2003 -0500, Jay Blanchard wrote:

> >[snip]
> >Just a remark but isn't it pointless to use Hungariannotation in a
> >language that is by default typeless???
> >[/snip]
> >
> >We use it becuase we have a group of programmers, so the notation makes
> >it easier for one in the group to understand the intention of another in
> >the group. The notation also helps to clear up any casting issues that
> >may arise. http://us2.php.net/language.types.type-juggling

> And it helps when you get back up to speed when you revisit a project

after

> a few months.
> Use of Hungarian notation has been a bit of a religious issue; use what
> works and use it consistently.
>
> Of course, if you come from the Flash world, it's likely a postfix (ugly
> word!) rather than prefix.
>
> Cheers - Miles
>
>
> --
> PHP General Mailing List (http://www.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>
>
> --
> This message has been scanned for viruses and
> dangerous content by Ontario Webs MailScanner, and is
> believed to be clean.
>
>

---
Outgoing mail is certified Virus Free.
Checked by AVG anti-virus system (http://www.grisoft.com).
Version: 6.0.507 / Virus Database: 304 - Release Date: 8/4/2003