Home > Articles

Follow the Naming Conventions

📄 Contents

  1. Capital Letters and Underscores
  2. Microsofties
  3. Brevity
  4. Dealing with It
  • Print
  • + Share This
As a maintenance programmer, conforming to an existing program's naming convention can be painful; however, follow these helpful tips and learn that there may be a method to the madness.
Like this article? We recommend

No two programmers write with exactly the same style. A programmer may not even be self-consistent. I sometimes forget my own coding style, and use different styles at different times, or even on the same file, modified over time. Sometimes_I_write_like_this, and otherTimesLikeThis.

It can be troublesome to read code written in somebody else's style, but it would be even worse to try to change somebody else's code to match your own style just to make it easier on yourself. That process is slow and error-prone, and programmers down the road will have to repeat it, because your style won't match theirs, either. The best thing you can do is to learn as many styles as you can, recognize the benefits and disadvantages of each, and love (or at least live with) whatever comes to you. Recall one of the most important principles of maintenance programming: Tread lightly.

Some naming conventions have become nearly universal. Here's a frequently-seen chunk of code:

for(int i = 0; i < args.length; i++)

Programmers had better know that i in this example is a standard integer index. This goes back to FORTRAN, where you didn't even have to explicitly declare the variable because the compiler assumed that it knew what you meant based on the first letter: Any variable beginning with i, j, k, l, m, or n is automatically an integer, and anything else is real.

I've even known a few programmers who wouldn't accept that, and would instead write this code as follows:

for(int indexIntoArgs = 0;
  indexIntoArgs < args.length;
  indexIntoArgs++)

More power to them, I guess, for using a nice descriptive name, but it's too bad that such a common idiom takes up three lines instead of one.

Some programmers prefer long, descriptive names, and others prefer short, punchy ones. The former are easy to read but tedious to type. The latter can be almost completely incomprehensible.

As a maintenance programmer, your best strategy is to mimic whatever code you're maintaining, although I have to admit that on occasion I've been forced to expand an overly abbreviated name or truncate a verbose one just to be able to read the code. But I do that in my own copy, not the copy I return to version control, because the potential to have missed something crucial is just too great.

The risk is that you could miss a use somewhere. At best, the program would fail to compile, but it's not even a sure bet that the compiler would catch the error. All too often, people take shortcuts around recompiling everything, and errors like that make it into operational code, where they materialize later as ugly crashes.

In addition, a global search-and-replace has an annoying tendency to replace too much. A programmer trying to substitute indexIntoArgs for i blindly will find that bad things have happened to the while loops as they become whindexIntoArgsle loops. And a manual search-and-replace is error-prone and tedious.

Modern refactoring tools, which operate based on the syntax of the program rather than just plain text, will make this easier. In addition to recognizing whole identifiers rather than just strings of letters, they understand the scoping provided by braces. Until you have one of those, however, the search-and-replace will be painful. Even if you do have a refactoring tool, there's good reason to avoid changing naming conventions, as we'll see shortly.

Capital Letters and Underscores

Let's look at some samples pulled from the Jakarta Ant project.

  • Main.java:

    private PrintStream out = System.out;
    private static void printMessage(Throwable t)
  • ClearCase.java:

    private String m_ClearToolDir = "";
    protected int run(Commandline cmd)
  • Wizard.java:

    private JProgressBar _progress = null;
    public void addWizardListener(WizardListener l)
  • ConstantPoolEntry.java:

    static public final int CONSTANT_InterfaceMethodRef = 11;
    public ConstantPoolEntry(int tagValue, int entries)

All of these examples declare fields in Java classes. Four files, four authors, four different naming conventions. Main.java makes no distinctions between fields, methods, and local variables. ClearCase.java tags fields with m_ (for member), while Wizard.java just uses the underscore. ConstantPoolEntry.java makes final variables all caps, similar to the #define convention in C. (#define caused me substantial grief when I was a C programmer. But that's another column.)

On the upside, all of these methods use pretty much the same convention for method names. In general, Java programmers seem to agree that BiCapitalization (separating multiple words in a filename with capital letters and no other marking) is the way to go with method and class names. I've also heard this strategy called camelCase, InterCaps, and a slew of other names. That's the standard followed pretty much universally by the Java SDK, at least the parts composed by Sun. Outside the Java SDK, things get a little hairier, as in this example from the OMG:

public abstract C:\Programs\jdk1.3.1\docs\api\org\omg\CORBA\Any.html 
add_named_in_arg(C:\Programs\jdk1.3.1\docs\api\java\lang\String.html name)

C programmers—and Java programmers who spent time as C programmers—tend to separate words in names with underscores instead, as in this example from the Linux scheduler:

static inline void enqueue_task(struct task_struct *p,
                prio_array_t *array)

Neither of these standards is inherently better than the other, which explains why both styles persist. I rejected BiCapitalization for a long time because it was the Pascal way of doing things rather than the C way of doing things. Now I prefer BiCapitalization since it's the Java way of doing things rather than the C way. I mention this to point out that your rationale for preferring your style to everybody else's is almost certainly just as silly.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020