You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flex.apache.org by Gordon Smith <go...@adobe.com> on 2012/08/18 02:53:45 UTC

Re: Mixed Case class names and SW, SWC etc

On second thought, changing them would be a bad idea because this convention comes from the flash.* API. In other words, it wasn't an arbitrary choice for Flex. As long as Flex is Flash-based, acronyms should not be mixed case, so that the API looks consistent at all levels of the platform stack.

- Gordon

-----Original Message-----
From: Gordon Smith [mailto:gosmith@adobe.com] 
Sent: Friday, August 17, 2012 5:42 PM
To: flex-dev@incubator.apache.org
Subject: RE: espenskogen@apache.org 

I wouldn't object if you want to change all of them, in all classes, interfaces, functions, etc. I would object to not being consistent.

- Gordon

-----Original Message-----
From: Tink [mailto:flex@tink.ws] 
Sent: Friday, August 17, 2012 3:14 PM
To: flex-dev@incubator.apache.org
Subject: Re: espenskogen@apache.org 

I've followed these coding standard for some time, it makes sense to keep all code to a particular standard, but I think is is one is a mistake.

I've so often ended up will classes like FXQSIForm, which would be so much better as FxQsiForm.

Tink


On 17 Aug 2012, at 20:08, Gordon Smith wrote:

>> SwfClassLoader.as
> 
> Hi, I wanted to mention that the Flex coding standards call for acronyms such as SWF and SWC to never be mixed case.
> 
> - Gordon


Re: Mixed Case class names and SW, SWC etc

Posted by Tink <fl...@tink.ws>.
I wasn't really suggesting changing them, as they would break a whole load of peoples code, just  pointing out that this is a mistake that leaves well named classes unreadable.

It also doesn't help with interfaces and Adobe convention of using a capital I's. If acronyms weren't all uppercase, an interface would be clear to see as it would be a capital I, followed by another capital letter. If the second letter wasn't capitalised, you'd know it was an interface.

For instance

ID3Info, interface or class? Id3Info would have made it clear that it was a class.


Tink


On 18 Aug 2012, at 01:53, Gordon Smith wrote:

> On second thought, changing them would be a bad idea because this convention comes from the flash.* API. In other words, it wasn't an arbitrary choice for Flex. As long as Flex is Flash-based, acronyms should not be mixed case, so that the API looks consistent at all levels of the platform stack.
> 
> - Gordon


RE: Mixed Case class names and SW, SWC etc

Posted by Gordon Smith <go...@adobe.com>.
I don't think I ever updated the naming conventions to reflect that decision, but I should have.

- Gordon

-----Original Message-----
From: Alex Harui [mailto:aharui@adobe.com] 
Sent: Friday, August 17, 2012 10:25 PM
To: flex-dev@incubator.apache.org
Subject: Re: Mixed Case class names and SW, SWC etc

Gordon, did we ever make a rule about prefixes?  Prefixes are most likely to result in capitalization issues like Tink is saying.  I remember we got loudly told by the community to remove the FX prefix from the Spark components and use namespaces instead.  Did we make that an official part of the naming conventions?

-Alex


On 8/17/12 5:53 PM, "Gordon Smith" <go...@adobe.com> wrote:

> On second thought, changing them would be a bad idea because this 
> convention comes from the flash.* API. In other words, it wasn't an 
> arbitrary choice for Flex. As long as Flex is Flash-based, acronyms 
> should not be mixed case, so that the API looks consistent at all levels of the platform stack.
> 
> - Gordon
> 
> -----Original Message-----
> From: Gordon Smith [mailto:gosmith@adobe.com]
> Sent: Friday, August 17, 2012 5:42 PM
> To: flex-dev@incubator.apache.org
> Subject: RE: espenskogen@apache.org
> 
> I wouldn't object if you want to change all of them, in all classes, 
> interfaces, functions, etc. I would object to not being consistent.
> 
> - Gordon
> 
> -----Original Message-----
> From: Tink [mailto:flex@tink.ws]
> Sent: Friday, August 17, 2012 3:14 PM
> To: flex-dev@incubator.apache.org
> Subject: Re: espenskogen@apache.org
> 
> I've followed these coding standard for some time, it makes sense to 
> keep all code to a particular standard, but I think is is one is a mistake.
> 
> I've so often ended up will classes like FXQSIForm, which would be so 
> much better as FxQsiForm.
> 
> Tink
> 
> 
> On 17 Aug 2012, at 20:08, Gordon Smith wrote:
> 
>>> SwfClassLoader.as
>> 
>> Hi, I wanted to mention that the Flex coding standards call for 
>> acronyms such as SWF and SWC to never be mixed case.
>> 
>> - Gordon
> 

--
Alex Harui
Flex SDK Team
Adobe Systems, Inc.
http://blogs.adobe.com/aharui


Re: Mixed Case class names and SW, SWC etc

Posted by Alex Harui <ah...@adobe.com>.
Gordon, did we ever make a rule about prefixes?  Prefixes are most likely to
result in capitalization issues like Tink is saying.  I remember we got
loudly told by the community to remove the FX prefix from the Spark
components and use namespaces instead.  Did we make that an official part of
the naming conventions?

-Alex


On 8/17/12 5:53 PM, "Gordon Smith" <go...@adobe.com> wrote:

> On second thought, changing them would be a bad idea because this convention
> comes from the flash.* API. In other words, it wasn't an arbitrary choice for
> Flex. As long as Flex is Flash-based, acronyms should not be mixed case, so
> that the API looks consistent at all levels of the platform stack.
> 
> - Gordon
> 
> -----Original Message-----
> From: Gordon Smith [mailto:gosmith@adobe.com]
> Sent: Friday, August 17, 2012 5:42 PM
> To: flex-dev@incubator.apache.org
> Subject: RE: espenskogen@apache.org
> 
> I wouldn't object if you want to change all of them, in all classes,
> interfaces, functions, etc. I would object to not being consistent.
> 
> - Gordon
> 
> -----Original Message-----
> From: Tink [mailto:flex@tink.ws]
> Sent: Friday, August 17, 2012 3:14 PM
> To: flex-dev@incubator.apache.org
> Subject: Re: espenskogen@apache.org
> 
> I've followed these coding standard for some time, it makes sense to keep all
> code to a particular standard, but I think is is one is a mistake.
> 
> I've so often ended up will classes like FXQSIForm, which would be so much
> better as FxQsiForm.
> 
> Tink
> 
> 
> On 17 Aug 2012, at 20:08, Gordon Smith wrote:
> 
>>> SwfClassLoader.as
>> 
>> Hi, I wanted to mention that the Flex coding standards call for acronyms such
>> as SWF and SWC to never be mixed case.
>> 
>> - Gordon
> 

-- 
Alex Harui
Flex SDK Team
Adobe Systems, Inc.
http://blogs.adobe.com/aharui