Give meaning and explanation with the fewest number of characters in a form that is most accepted by your team or community at large.
2
votes
6answers
306 views
Naming functions that retrieve a value
I have this personal rule to start all function/method names with a verb. My verb of choice for functions or methods that get a value based on some data structure or object is get. I'm wondering if ...
1
vote
3answers
265 views
“Is” prefix and “On” suffix as reasonable exceptions to a “non-hungarian” naming standard?
First, I believe I've seen this question discussed here before, but I cannot find it. My apologies if you do find it.
I'm starting a new project, and trying to figure out why IsResolved and/or ...
7
votes
2answers
281 views
What does Uncle Bob mean by 'noun phrase names'?
I am reading Clean Code by Uncle Bob. Because I am not a native-English speaker, I couldn't understand following statement:
Classes and objects should have noun or noun phrase names like
...
5
votes
6answers
255 views
Data structure for accessing units of measure
TL;DR - I'm looking for the "optimal" data structure to define units within a unit of measure.
A Unit of measure is essentially a value (or quantity) associated with a unit. SI Units have seven ...
2
votes
3answers
211 views
Naming the project containing only interfaces
I've extracted interfaces from my repository classes, like ICustomerRepository, IProductRepository and so on. The project which contains the repositories is named X.DataAccessLayer. Should I call the ...
0
votes
3answers
188 views
What Http verb should the route to log out of your web app be?
Browser support issues aside, if you're being an Http/hateoas stickler what verbs should the request to log into/out of a site be?
DELETE would seem like the obvious choice but I'm not sure what the ...
12
votes
2answers
539 views
Boolean Method Naming Affirmative vs Negative
Should boolean methods always take the affirmative form, even when they will only ever be used in the negative form?
Say I wanted to check whether an entity exists before creating one, my argument is ...
0
votes
2answers
73 views
What is the convention regarding class names that may already exist in the ORM?
This is a generic question about class names and ORMs, but for context; I'm working on a Flask web app in Python using SQLalchemy.
I'm struggling with naming a new class that will contain the ...
2
votes
5answers
242 views
What's the dominant naming convention for variables in PHP: camelcase or underscores?
The consensus seems to be that one should follow the convention of the platform they're developing for. See:
Underscore or camelcase?
Naming conventions: camelCase versus underscore_case?
However, ...
-1
votes
1answer
103 views
Naming a class that does Importing and exporting of data
I've been thinking about creating a class that handles importing and exporting of data, and I feel that naming it FooImporterExporter might look too long, I wan't to see if there's a name convention ...
6
votes
1answer
148 views
Naming of related classes and interfaces
I have created an ObjectParser class which parses data into strongly typed objects using an IObjectParserDataSource as the data source (the data could be an Excel file, text file, array, query string, ...
1
vote
0answers
103 views
Lookup tables, code keys, or slowly moving dimensions [closed]
I am looking for a concise notion or term for the concept of "lookup tables". Under this concept I understand a data structure where detailed and mostly stable information is stored under a unique ...
3
votes
1answer
232 views
How to explain to your colleages to stop creating packages and classes named “Utils”?
In most of the projects at work it will eventually show up a package, a class (or multiple packages and classes) named "Utils", where every kind of function is dumped into.
It becomes excruciating ...
6
votes
1answer
259 views
Term for a Class with Multiple Interfaces
Say I have a class that implements multiple interfaces. I pass the same instance around using a different interface, depending on what the consumer is interested in.
I am trying to remember what this ...
1
vote
2answers
221 views
Choosing between words with different spellings for function names
A question has been bothering me for a while: when developing international projects, it is common sense to use English as the reference language since it is the language that the most people ...
8
votes
3answers
450 views
The problems with Avoiding Smurf Naming classes with namespaces
I pulled the term smurf naming from here (number 21). To save anyone not familiar the trouble, Smurf naming is the act of prefixing a bunch of related classes, variables, etc with a common prefix so ...
2
votes
4answers
198 views
Derived Class Method Naming
I'm having a hard time coming up with a good naming convention for methods in derived classes that serve the same purpose as the methods in the base class. For example, if both the base class, and the ...
3
votes
5answers
149 views
A good name for a variable containing either Row and Column objects? [closed]
I'm working with grids and I have several variables that relate to elements that can be either rows or columns. I'm growing tired of naming those variables rowOrColumn_something.. Any ideas?
UPDATE:
...
3
votes
3answers
200 views
Is it correct to exclude argument names from function prototypes?
I was recently creating a small technical documentation for an application. The document is to be used by newly hired programmers to get acquainted with the application. It is much friendlier than the ...
6
votes
2answers
371 views
Is there a name for this design pattern?
I don't like singletons, but I have to compromise now (but only as temporary measure).
However I don't want to go completely singleton. I'd rather want to use this pattern:
interface ...
0
votes
3answers
204 views
Is there an accepted name for a fake object injected via a preprocessor seam?
I am dealing with some old, sloppy C++ code in which there is a structure with a lot of data members and functions. I want to test a class that I have implemented which uses the struct, but this ...
0
votes
0answers
30 views
How to call module that contains only application settings and localization information?
I want to separate one module (.NET assembly) that will contain settings and localization strings in three languages. How to call that module?
7
votes
2answers
181 views
The suffix Exception on exceptions in java
Specifying a suffix of Exception on exception classes feels like a code smell to me (Redundant information - the rest of the name implies an error state and it inherits from Exception). However, it ...
0
votes
1answer
184 views
Is C# namespace should be Project-Name?
I am working with multiple websites (freelancer) and a good amount of them I write using C# MVC4.
I created a very good boilerplace project that I plan to use on every next starting mvc4 application ...
0
votes
5answers
216 views
Naming for a class that consumes an iterator pattern [closed]
The iterator pattern is very clearly defined. What would you call the consumer of an iterator?
1
vote
2answers
140 views
organising classes / folder structure for TDD-based development
Due to test-driven development, one ends up with many classes doing just one thing. It is quite a headache just to see where such classes would be placed inside the folder structure.
First of all, ...
27
votes
9answers
2k views
Is it considered poor practice to include a bug number in a method name for a temporary workaround?
My coworker who is a senior guy is blocking me on a code review because he wants me to name a method 'PerformSqlClient216147Workaround' because it's a workaround for some defect ###. Now, my method ...
59
votes
6answers
3k views
Should the variable be named Id or ID?
This is a bit pedantic, but I've seen some people use Id as in:
private int userId;
public int getUserId();
and others use:
private int userID;
public int getUserID();
Is one of these a better ...
0
votes
2answers
102 views
addIfNotExist alternative
Is there are any standards or conventions on naming methods which add something if it not exist into another something.
For example: Store.instance().addItemIfNotExist(item)
IfNotExist is really ...
9
votes
3answers
233 views
How can I avoid using my own name in the identifiers, packages, or namespaces of open sources projects I create?
I do a lot of development in my own time. These projects I work on are all just for fun and learning (so far). I commonly do Java development with Maven but I have also been known to dabble in .NET ...
-3
votes
2answers
79 views
naming abstract class [closed]
I have an abstract class representing a test assertion. How should I name it and why?
Assertion
AssertionBase
AssertionAbstract
[other]
1
vote
1answer
211 views
Name for a tree where nodes hold a reference to their parent as well as their children
I am creating a tree where some nodes have a reference to their parent as well as their children. It feels like a tree version of a doubly linked list.
Is there a name for this?
38
votes
7answers
2k views
How to name a variable when the word is both a noun and a verb
I have run into a corner-case problem with the general guidance of:
nouns for variables
verbs for functions
Specifically, I have a case where the word is ambiguous - it can be either a verb or a ...
1
vote
2answers
81 views
Name for intentionally assertless unit test [closed]
I have a tool that is going to be run as part of commit stage on Continuous Integration server to check whether all unit tests run do have an assert. Its main purpose is to eliminate silly mistakes ...
5
votes
4answers
183 views
Word for the superset of files and folders
I'm trying to come up with a name for a class that can represent both files and folders. Anyone know a word for this?
4
votes
1answer
99 views
Advices on structure and names for namespaces and classes
I'm resistant to calling the "main" class the same as the namespace, but I sometimes find myself needing it. Considering I'm using the Vendor.Namespace.[Subnamespace].Class formula, imagine this ...
12
votes
8answers
664 views
How and why to decide between naming methods with “get” and “find” prefixes
I always have trouble figuring out if I should name a certain method starting with getSomething versus findSomething.
The problem resides in creating helpers for poorly designed APIs. This usually ...
3
votes
1answer
91 views
Representing domain objects
This is related to my recent question regarding naming awkward domain objects. A number of answers indicated I was using the wrong representation for the domain objects. To summarize, I chose to use ...
-1
votes
3answers
152 views
Need help with the naming convention for an incremental variable [closed]
I am using a voting module, that allows you vote either up or down [or reset].
If you vote up, the value is +1.
If you vote down, the value is -1.
If you vote up then down, the value is -1.
I want to ...
11
votes
6answers
419 views
Guidance in naming awkward domain-specific objects?
I'm modeling a chemical system, and I'm having problems with naming my elements / items within an enum.
I'm not sure if I should use:
the atomic formula
the chemical name
an abbreviated chemical ...
5
votes
3answers
580 views
Why the name 'continue' [closed]
The 'continue' keyword in Java (and probably in many other programming languages) is used to skip further execution of the current iteration.
Why was the name 'continue' chosen? Why not something ...
4
votes
1answer
166 views
Java-style package naming and second-level country domains
I own a .co.uk domain, and I whenever I've dealt with Java-style package naming, I've gone with uk.co.domainname. Once I encountered package that did the following: co.uk.domainname.
Is one of these ...
1
vote
1answer
134 views
Am I missing a pattern?
I have a class that is a singleton and off of the singleton are properties that hold the instances of all the performance counters in my application.
public interface IPerformanceCounters
{
...
1
vote
6answers
453 views
“Mac” vs “OS X” vs “Mac OS X” [closed]
I am writing server software that gives administrators options that apply only to Mac OS X clients. When naming those options, I need to decide how I am going to refer to such clients. I can see three ...
3
votes
1answer
197 views
Distinguishing between UI command & domain commands
I am building a WPF client application using the MVVM pattern that provides an interface on top of an existing set of business logic residing in a library which is shared with other applications. The ...
4
votes
3answers
328 views
What should I use for a package name if I don't have a domain? [duplicate]
Possible Duplicate:
What is the point of Java’s package naming convention?
What package name to choose for a small, open-source Java project?
I write Java (and derivative languages with ...
4
votes
2answers
605 views
Naming convention: field starting with “m” or “s”
I saw lot of code (for example some Android source code) where fields name start with a "m" while static fields start with "s"
Example (taken from Android View class source):
private ...
-1
votes
4answers
128 views
Identifier for the “completed” stage of a process: 0, 99, something else?
Say, that you are handling a multi-step process (like a complex registration form, with a number of steps the user has go through in order). You need to be able to save the current state of the ...
2
votes
4answers
179 views
Function names - “standardized” prefixes
Imagine you have such routines
/*just do X. Fail if any precondition is not met*/
doX()
/*take care of preconditions and then do X*/
takeCareOfPreconditionsCheckIfNeededAtAllAndThenDoX()
A little ...
93
votes
16answers
19k views
Is there an excuse for short variable names?
This has become a large frustration with the codebase I'm currently working in; many of our variable names are short and undescriptive. I'm the only developer left on the project, and there isn't ...
