"A", "an", and "the" in method and function names: What's your take?

Posted by Mike Spross on Programmers See other posts from Programmers or by Mike Spross
Published on 2010-09-16T04:56:54Z Indexed on 2011/02/09 23:34 UTC
Read the original article Hit count: 248

Filed under:

style-guide

|

naming-conventions

I'm sure many of us have seen method names like this at one point or another:

UploadTheFileToTheServerPlease
CreateATemporaryFile
WriteTheRecordToTheDatabase
ResetTheSystemClock

That is, method names that are also grammatically-correct English sentences, and include extra words purely to make them read like prose. Personally, I'm not a huge fan of such "literal" method names, and prefer to be succint, while still being as clear as possible. To me, words like "a", "an", and "the" just look plain awkward in method names, and it makes method names needlessly long without really adding anything useful. I would prefer the following method names for the previous examples:

UploadFileToServer
CreateTemporaryFile
WriteOutRecord
ResetSystemClock

In my experience, this is far more common than the other approach of writing out the lengthier names, but I have seen both styles and was curious to see what other people's thoughts were on these two approaches.

So, are you in the "method names that read like prose" camp or the "method names that say what I mean but read out loud like a bad foreign-language-to-English translation" camp?

© Programmers or respective owner

Related posts about style-guide

A standard style guide or best-practice guide for web application development

as seen on Programmers - Search for 'Programmers'
I run a very small team of developers on a web application, just three people (and not even full time). We're all capable developers, but we write our code in very different ways: we name similar things in different ways, we use different HTML and CSS to achieve similar outcomes. We can manage this… >>> More
Google C++ style guide

as seen on Stack Overflow - Search for 'Stack Overflow'
I am curious as to what people think of the google C++ style guide. http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml I see references to it scattered across stackoverflow and would like to collect your opinions as to what you think about it. >>> More
CSS style guide question

as seen on Stack Overflow - Search for 'Stack Overflow'
What are the best practices with respect to styling HTML elements using CSS? What's the preferred granularity for styling HTML elements? i.e., do you have lots of div.searchbox input div.searchbox p div.searchbox p.help OR input.searchbox p.searchbox p.searchboxhelp Which css code is considered… >>> More
Style guide for database metadata naming

as seen on Stack Overflow - Search for 'Stack Overflow'
We want to establish some database metadata naming rules in our new project. For example: tables are named as nouns in a plural form (courses, books, lessons) if present, an adjective goes before a noun in a table name and is separated by an underscore (red_books, new_lessons) table index column… >>> More
Do you know any style guide for Python?

as seen on Stack Overflow - Search for 'Stack Overflow'
Do you know any style guide for Python like "Code Like a Pythonista"? I found chapter 2.3.4 of Expert Python Programming very interesting too. >>> More

Related posts about naming-conventions

Entity Framework naming conventions for many-to-many link tables

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, We are designing a SQL Server database with link tables for many-to-many relations. The question is are there any best practices for naming these kinds of tables for use with the entity framework? Let's say there's a table Customer and Address Then there is a link table between them, what… >>> More
Python Naming Conventions for Dictionaries/Maps/Hashes

as seen on Stack Overflow - Search for 'Stack Overflow'
While other questions have tackled the broader category of sequences and modules, I ask this very specific question: "What naming convention do you use for dictionaries and why?" Some naming convention samples I have been considering: # 'value' is the data type stored in the map, while 'key' is… >>> More
Enforce SSIS naming conventions using BI-xPress

as seen on SQL Blog - Search for 'SQL Blog'
A long long long time ago (in 2006 in fact) I published a blog post entitled Suggested Best Practises and naming conventions in which I suggested a bunch of acronyms that folks could use to prefix object names in their SSIS packages, thus allowing easier identification of those objects in log records… >>> More
Product Naming Conventions - Does it make sense

as seen on SQL Blogcasts - Search for 'SQL Blogcasts'
Maybe it’s just me, but with some of the MS Products being released in 2010 with "2010" in their product name, is the naming of the SQL Server product suite being released with product name that doesn’t make sense, our latest SQL Server Release which is now just about to be released is "SQL… >>> More
naming conventions for buttons in user interface

as seen on Stack Overflow - Search for 'Stack Overflow'
User interface for web applications in general contain various buttons for performing CRUD operations. What would be the suggested naming convention for button labels while performing the following actions.. User creation (Add User... or Add User or Add user) Event creation (Add Event... or Add… >>> More