Questions tagged [naming-standards]
The naming-standards tag has no usage guidance.
147
questions
2
votes
4answers
117 views
Naming convention for functions that mutate arguments vs creating a new object
Take the following signature
BigInt* addBigInt(BigInt* arg1, BigInt* arg2);
Traditionally, the safest way to implement this function would be for it not mutate the arguments, and would necessarily ...
-2
votes
0answers
36 views
What is the best naming convention for a component that updates the state of an object? [closed]
What is the best naming pattern for a component that updates the state of an object?
Suppose I am writing a game. This game has an object called GameState. The GameState merely holds the data relevant ...
-2
votes
1answer
46 views
How are methods called that prepare/alter some data and then pass it on
I am currently trying to name a method that prepares/alters some input data, then passes it on, and I'm wondering if there is a naming scheme for such methods.
Concretely, I have a reusable UI ...
-2
votes
1answer
179 views
Why is it so often written “myID” instead of “myId” [closed]
I very often see code containing the variable names "myID", while "ID" stands for "Identifier".
Why should it be ID?
The same goes for GUID/UUID, shouldn't that be GUId/...
0
votes
0answers
65 views
Spring boot, n-tier layer structure naming conventions
I am currently developing a huge project in my company with N-Tier Layer architecture using spring boot but I can not sure about the package and class namings. In our project, we have a complex ...
2
votes
0answers
57 views
Function naming: choosing the order of nouns / verbs in the name
I'm sometimes torn between two naming conventions defining the order of words that make up a function name. The first one is choosing the words in the same order we would natural use in a sentence, ...
-3
votes
1answer
52 views
Standarized prefixes for naming REST POJO (Bad or good practice)? [closed]
We are building a software application for a client with a particular naming convention for REST services.
For example if you use a POJO for your request or response in a REST service something like ...
4
votes
3answers
200 views
Naming function with “proceed”
I am wondering if it is good practice to name function which does the main logic "proceed" + "functionName".
I would use that name if there are some checks(if-s, try-catches, etc.) ...
-3
votes
1answer
62 views
What could be a better naming convention for the variable 'completeConfig'?
I have a feature in which the user can directly provide the entire nginx config inside the completeConfig variable in the config yaml.
Like this:
nginxConfig:
completeConfig: >
....
....
...
0
votes
2answers
124 views
Which approaches are exists for using of possessive case in variables/classes/methods naming?
In variables/classes/methods naming, sometimes "of" preposition is omitted and word order changing, for example:
"Absolute path of source file of entry point" -> "...
4
votes
2answers
209 views
Should the name of a method be less descriptive if its class/module alread is enough?
I have a module or class Random and in it there's a method called generate(). A client will always call it as res = Random.generate(). And from the inside, obviously, it can be called simply as ...
1
vote
2answers
226 views
What is a good naming convention for Interface Adapters, Use Cases / Interactors, Entities?
I'm using MVVM + Clean Architecture in my app. And I sometimes don't have any idea if my namings are good enough for each Interface Adapters, Use Cases / Interactors, Entities. For View Models, it's ...
-3
votes
2answers
100 views
Naming conventions for set/unset method parameter
I have some class MyClass which has two methods:
Lock(){}
Unlock(){}
For some reasons, the two methods are to be unified into one, with an additional parameter for indicating the action. What should ...
0
votes
1answer
109 views
How to avoid messy code when working with different libraries
I'm planning to work with different libraries that use different conventions. One uses snake_case, another one uses camelCase. This leads to code that looks like I can't make up my mind:
Some_Result ...
0
votes
6answers
209 views
Naming boolean fields in classes
I have had hard times naming boolean fields.
On the one hand, i've read that it is good to name them as affirmative statements, like hasAge, or canDance. It's not a problem when naming local ...
-4
votes
3answers
125 views
Should I prefix keys of JS object with the object's name?
Let's get to an example. Suppose, I have a Course object with the following properties: (course' code, course's title, credit of course etc.). When expressing this as a JS object, I can do it in the ...
0
votes
2answers
143 views
How to name two versions of the same object, where one has a smaller amount of data and one is the “complete” object
What is the best way to name two classes that describe the same object, but where one of those classes does not hold the complete information? And should I make one of the classes inherit from the ...
4
votes
2answers
252 views
When to use third-person verb? (PlayOnAwake or PlaysOnAwake)
First a couple of examples:
var val = obj.GetValue();
var can = obj.CanPlay;
var has = obj.HasValue;
var val = obj.RequiresConstantRepaint(); // From Unity
var val = obj.PlayOnAwake; // From Unity
...
23
votes
3answers
6k views
Why are module-specific prefixes widely used for function names in C modules?
In some C projects, function names start with a common prefix indicative of the module name, for example:
mymodule_do_this_stuff();
mymodule_do_that_stuff();
Is there a justification for doing so ...
2
votes
3answers
310 views
Use prepositions in naming verb-phrase functions?
When writing a library, designing a class or extending some existing API, we often need to express actions or relations involving noun entities:
"Place the ball in the bin"
"Obtain the coat for the ...
-2
votes
2answers
200 views
Python function name convention for “convert foo to bar”, e.g., foo_to_bar, foo2bar
I have a function that converts args given by argparse to a filename:
def args2filename(args, prefix):
filename = prefix
kwargs = vars(args)
for key, value in sorted(kwargs.items()):
...
1
vote
3answers
283 views
Should I give an object that holds multiple objects of the same type a plural name?
I have an object:
const riders = {
Dave: {
gender: 'male',
age: 13,
},
Nina: {
gender: 'female',
age: 16,
},
Mike: {
gender: 'male',
...
2
votes
2answers
66 views
API naming for authentication API composed by many steps
I have an API which include a registration and login process. Both process have an authentication sub-process. This sub-process are many steps which API validate a client specific data.
I have many ...
0
votes
3answers
476 views
How to name functions with multiple return values
In many languages, it is common for a function to have multiple return values (as a tuple), such as:
def foo():
return "Hello, World!", 0
I often do this when a computationally expensive (or an ...
1
vote
3answers
298 views
How should I name output variables that are the same as the function?
What are some conventions for naming a variable in cases where the name of the variable ought to be identical to the name of the function? I'm using VB.Net.
I often have this problem when writing ...
2
votes
1answer
97 views
Naming a software which allows communication between two independend systems via internet [closed]
Probably a trivial question but I just don't know how that piece of software would be called correctly:
I have a closed system (A) and an application on another system and location (B). The ...
1
vote
2answers
73 views
naming the classes for users of my app, and users who manage the app
Naming things is hard but naming them properly is really hard. We are working on an app, that analyzes the data of multiple apps and creates some reports.
And we are hitting our heads against walls ...
-1
votes
2answers
135 views
Common way to name methods with same name as desired variable? [closed]
I frequently find myself pulling up helper methods in order to make my code better, but end up with duplicate method names. Is there a standard way to name such methods without getting duplicate names?...
0
votes
2answers
1k views
Booleans Naming conventions : How to prefix a “show” boolean? [closed]
I've seen here that it was a dividing topic to use "should" as a prefix for a boolean because it could mean that we're unsure.
Then how would you prefix a boolean such as "myButton.shouldShow"?
I ...
1
vote
1answer
64 views
Need help with naming substate
I'm designing an application which accepts a command, processes it and produces a result. Application will maintain the status of the input command as 'new', 'processing' and 'completed' as it ...
1
vote
1answer
77 views
What should I call a flag to maybe disable some behaviour? [closed]
Say I have a function:
def foo(x):
if x % 2:
do_something_with(x)
return x
And I want to make the doing of something opt-outable:
def foo(x, maybe_do_something_with_x=True):
if ...
2
votes
1answer
385 views
Naming Convention [closed]
When we determine names for the variables, there are two important issues that the people mention:
The variable names must be explanatory. For the sake of this, their names can be long.`
The variable ...
2
votes
4answers
1k views
C# class naming convention for a single item in the item list [closed]
In my C# project, I have a domain class named 'User'. this class will contain user's id, firstname, last name, DoB, home address, phone, etc. And we also have a typical REST web api (i.e. api/users) ...
1
vote
2answers
701 views
Using “On” at the start of a method name
From what I've observed, methods that start with the word "On" fall into two categories:
A base class that defines an event will expose a protected method whose name starts with "On" followed by the ...
0
votes
1answer
68 views
Variable naming for collaboration between software engineering and data science
There exist lots of discussions on variable naming. However, I would like to address a specific aspect. I am a data scientist and deal with dozens of features/variables/columns — however you may call ...
3
votes
1answer
243 views
Application_Start() vs ApplicationStart()
Why is the method in Global.asax called Application_Start() and not ApplicationStart()?
According to MSDN method names should be in Pascal case.
2
votes
1answer
53 views
Does any scale exist (e.g. naming convention to be used for sizes) that allows trivial insertions at any point in the scale?
Question probably sounds confusing so let me clarify.
Let's say I have an object containing keys and values for my project's font sizes:
{
small: '8px',
medium: '11px',
large: '14px',
}
...
7
votes
4answers
1k views
Is it a good practice to end a function's name with a preposition?
I have seen examples of methods whose name ended with a preposition applying to the first (and most often only) parameters.
But other examples don't use this kind of naming convention.
Which do you ...
0
votes
2answers
218 views
Is there a rule of thumb when it comes to the “name” attribute?
Since there is things like BEM in naming conventions for HTML class attributes, does the name attribute have anything of that sort?
0
votes
1answer
137 views
What to specify as interfaces in component diagrams
I am following the textbook Object oriented software specification using UML, patterns and Java (3rd edition) and I am defining interfaces between system components (subsystems). But I encountered a ...
2
votes
1answer
942 views
Naming conventions for pure functions
Are there 'conventions' / best practices on naming pure functions?
For example:
adding numbers: add or sum?
calculating the square root: calcSqrt or sqrt?
reversing a list: reverse or reversed?
...
0
votes
3answers
218 views
Naming variable which describes that something is currenty in use
I'm creating a variable which should describe that an object is currently in use. Lets say we have a form with a password input, and I want to describe the state when someone is using that input.
Is ...
-1
votes
2answers
253 views
SQL Coding Naming convention: Variable same name as Columns
Is there a coding naming convention principal for SQL variables? Can variables be named the same as column names, I heard in different companies, this may cause confusion. However in C# below, its a ...
0
votes
1answer
84 views
Co-ordination between technologies following different naming conventions [duplicate]
Javascript community generally follows camel case naming convention, whereas while writing REST api URLs follow snake case naming conventions.
What would be the better naming convention for the ...
6
votes
1answer
327 views
Is it a good practice to redefine unavailable keywords as macros?
Is it a good practice to redefine unavailable keywords with macros?
I use GCC 4.8 in one of my projects which isn't exactly C11 standard compatible. At least not the extent of 4.9. But there are some ...
3
votes
2answers
551 views
How to name a Boolean variable that represents either of two options?
I'm developing an application with Python. I want to have a Boolean variable that represent whether something is buy or sell but I'm not sure how I should name it. Here are my current ideas:
isBuy
...
3
votes
2answers
1k views
Method naming: to vs as vs get
Do the words to, as and get have any special meaning when used in method names?
Examples
to
new Integer(4).toString()
get
Integer.getInteger("system.unknown.property",4)
as
Arrays.asList(...
0
votes
1answer
193 views
Is a URC (Uniform Resource Citation) synonymous with a Query String or Url Parameters?
Reading this:
https://renenyffenegger.ch/notes/development/web/URI-URL-URN-IRI-URC
URCs provide a set of attribute/value pairs that describe properties of URIs like authorship, publisher, ...
-3
votes
3answers
167 views
Ambiguous use of “User”
In one of my projects, I had to name some variables and functions that belong to the person using my app. I named them userCard, getUserInventory() and so on. I named them like that cause there were ...
0
votes
3answers
487 views
RESTful APIs: Terminology for Update Modes/Types
When designing a RESTful API, providing a spec for updating an entity will force the designer to make some decisions on how the update will behave (an update mode or type). Here are some of the modes ...
