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
0answers
62 views
Examples of bad variable names and reasons [on hold]
I'll start with a class in the jdk package :
public final class Sdp {
should be :
public final class SocketsDirectProtocol {
Sdp is class name, this is ambigious, should be :
Class<?> ...
4
votes
6answers
170 views
Naming conventions used for variables and functions in C
While coding a large project in C I came upon a problem. If I keep on writing more code then there will be a time when it will be difficult for me to organize the code. I mean that the naming for ...
6
votes
3answers
253 views
Why is Quicksort called “Quicksort”?
The point of this question is not to debate the merits of this over any other sorting algorithm - certainly there are many other questions that do this. This question is about the name. Why is ...
0
votes
4answers
99 views
Naming: objectAction or actionObject?
The question, Stored procedure Naming conventions?, and Joel's excellent Making Wrong Code Look Wrong article come closest to addressing my question, but I'm looking for a more general set of criteria ...
4
votes
3answers
108 views
C project avoiding naming conflicts
I'm struggling to find pragmatic real-world advice on function naming conventions for a medium sized C library project. My library project is separated into a few modules and submodules with their own ...
-2
votes
0answers
69 views
correct name for a method [closed]
I am struggling with a name for a method. The implementation is already done, I am just looking for a good name!
potential candidates :
Segregation
Extract
Split
The Method
IEnumerable< ...
2
votes
3answers
103 views
What are good words for defining multiples?
In databases you might take about one-to-many. This means there's one thing that maps to zero or more others.
In this kind of style I'm looking for words that define min/max amounts of things. So ...
3
votes
4answers
101 views
naming convention for different types of functions (use prefixes or suffixes?)
Does anyone have suggestions for naming conventions for different types of functions, particularly wrapper functions that need to connect to and disconnect from the database vs. wrapper functions that ...
4
votes
3answers
136 views
What is a good rule-of-thumb for naming link-tables?
In the same way that a publication table might relate to a person table via subscriptions, or a company table might relate to a person table via employee, I'm wondering if there is a descriptive way ...
1
vote
2answers
124 views
Which is architecturally correct for Data Access Layer method names - Fetch or Select? [closed]
I have seen the words Fetch and Select used seemingly interchangeably when naming data access layer methods (ex. Person.Select or Person.Fetch). Which one is correct?
My instinct is that the ...
2
votes
6answers
325 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
4answers
359 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
394 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
337 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
222 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
200 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 ...
14
votes
2answers
691 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
78 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
326 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
110 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
159 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
113 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
237 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
260 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
236 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
491 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
263 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
151 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
205 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
373 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
212 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
31 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
190 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
214 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
217 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
158 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
105 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
250 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
81 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
219 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
86 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
189 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
107 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
673 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
94 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
425 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 ...
