[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

Re: Id vs. ID in SAX

  • From: Uche Ogbuji <uogbuji@o...>
  • To: Elliotte Rusty Harold <elharo@m...>
  • Date: Sun, 09 Apr 2000 20:30:10 -0600

id capitalization
> I've been getting increasingly flustered about the constant use of the
> the initial capped "Id" to refer to an identification instead of the
> all-cap "ID". This occurs throughout the SAX APIs in both method
> arguments and method names. Somehow this just looks wrong to me. I know
> the DOM does it too, but I think they're wrong as well.
> 
> Since the word ID is capitalized in common usage, it should be
> capitalized in Java names as well. This is similar to how URL is
> captialized in class names like java.net.URL and method names like
> getURL() in the Java core library.
> 
> This is actually a pretty big change to suggest. Most of the offenders
> are method argument names that can be changed without affecting anyone.
> However, there are also a lot of method names like getPublicId()
> scattered throughout SAX2.
> 
> What do people think? Is anyone else having the immediate gut reaction
> that these names are misspelled that I get when I read the
> documentation?

I'm very late to this argument (just catching up again), but I was compelled 
to immediate and violent disagree.  I have always advocated treating acronyms 
and abbreviations as words for purposes of capitalization in code standards.

For instance, our internal standards demand the following naming patterns:

SaxToDomHandler

DeployNatoJstarsAndAwacs

and of course

GetObjectById

I find this far more readable than DeployNATOJSTARSAndAWACS and the like.

In fact, I have the opposite problem with the W3C DOM group: that they got 
"GetElementsById()" right but DOMImplementation wrong.

Regardless, I think we can all agree that consistency is important regardless 
of aesthetic preference.

-- 
Uche Ogbuji                               Senior Software Engineer
uche.ogbuji@f...               (303)583-9900 x 101
Fourthought, Inc.                         http://Fourthought.com 
4735 East Walnut St, Ste. C, Boulder, CO 80301-9036
Software-engineering, knowledge-management, XML, CORBA, Linux, Python



***************************************************************************
This is xml-dev, the mailing list for XML developers.
To unsubscribe, mailto:majordomo@x...&BODY=unsubscribe%20xml-dev
List archives are available at http://xml.org/archives/xml-dev/
***************************************************************************

PURCHASE STYLUS STUDIO ONLINE TODAY!

Purchasing Stylus Studio from our online shop is Easy, Secure and Value Priced!

Buy Stylus Studio Now

Download The World's Best XML IDE!

Accelerate XML development with our award-winning XML IDE - Download a free trial today!

Don't miss another message! Subscribe to this list today.
Email
First Name
Last Name
Company
Subscribe in XML format
RSS 2.0
Atom 0.3
 

Stylus Studio has published XML-DEV in RSS and ATOM formats, enabling users to easily subcribe to the list from their preferred news reader application.


Stylus Studio Sponsored Links are added links designed to provide related and additional information to the visitors of this website. they were not included by the author in the initial post. To view the content without the Sponsor Links please click here.

Site Map | Privacy Policy | Terms of Use | Trademarks
Free Stylus Studio XML Training:
W3C Member
Stylus Studio® and DataDirect XQuery ™are products from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2013 All Rights Reserved.