Questions tagged [naming]
Give meaning and explanation with the fewest number of characters in a form that is most accepted by your team or community at large.
19
questions with no upvoted or accepted answers
2
votes
1
answer
285
views
GetOrCreate method for a database operation
I have read this thread: Is it bad coding practice to create something in a get if it does not exist?
But, my question involve a method which gets a record from a database or creates it if it doesn't ...
- 129
2
votes
0
answers
125
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, ...
- 328
1
vote
0
answers
234
views
What is a Function that Creates Functions Called?
Let's say I have the following function (in JavaScript, for sake of example):
function foo() {
var bar = function () {return 'lol';}
return bar;
}
This function returns other functions. I had ...
- 139
0
votes
0
answers
71
views
Download method of type void vs response
Given a method that is widely used and has a void return type:
from somepackage import download_model
from somepackage import get_filename
def download(name, download_path):
response = ...
- 582
0
votes
1
answer
93
views
Distributing responsibilities in a micro service in an Object Oriented manner for a 3rd party integration?
I'm trying to figure out how to structure a 3rd party integration microservice, and how to name the classes accordingly. If you had a classic shopping cart application which processed payments for ...
- 19
0
votes
0
answers
39
views
Terminology for cumulative vs non cumulative functions on timeseries data
Say you had some (contrived) timeseries data like:
time | 1 | 2 | 3 | 4 | 5 |
temp 1 | 3 | 3 | 4 | 4 | 5 |
temp 2 | 2 | 2 | 2 | 2 | 2 |
...etc
Is there a particular ...
- 11
0
votes
0
answers
77
views
Is it a bad practice to have a class with a namespace that goes "out" of it's project name?
I have a solution with multiple projects, lets suppose there's one project with the name Company.Name.Foo.Bar.
If I declare a class inside the project Company.Name.Foo.Bar but with a namespace Company....
- 329
0
votes
0
answers
73
views
How to name multiple entities returned from a Query Handler?
I've got the following flow:
HTTP API is exposing data from 2 database tables that are combined into one JSON structure. We're implementing this using CQRS - splitting the reads from multiple tables ...
- 191
0
votes
0
answers
148
views
Qt Naming Schemes for returns of boolean member variables: enabled(); vs isEnabled(); ?
In building my classes, I have noticed that I have not been very consistent about naming my boolean returns. In Qt; I notice that many of their classes use the is prefix, but checking their coding ...
- 3,319
0
votes
0
answers
34
views
Name of the operation where whole table is put in array format
Consider this data struture:
key1 : value1
key2 : value2
key3 : value3
I have an operation that put this data in array format:
key1, value1, key2, value2, key3, value3
Which would the the name of ...
- 687
-1
votes
1
answer
35
views
Best practices for naming python utils / extending core modules?
So a lot of the time my utils end up with a structure that mirrors the core library. I might end up writing a multiline version of str.center, an itertools-y function that returns the first or last ...
- 11
-1
votes
1
answer
68
views
How to name functions which continue a process after an asynchronous step
Say that you have an web application which prints pages in a document. Suppose that after validating the page range, the application does the following:
If a billing option is turned on, it first ...
- 139
-1
votes
1
answer
955
views
What to name package and their facade classes?
I'm using a some C++ Facade classes like this:
Suppose that there is package named "SubSystem" with a lot of classes inside, like in the picture above.
I cannot name the package of the facade ...
- 395
-2
votes
1
answer
51
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 ...
- 97
-3
votes
1
answer
67
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: >
....
....
...
-3
votes
1
answer
758
views
What naming convention should I use for a JSON RPC client API designed for multiple languages?
This is the documentation with the original RPC client API specification. The naming convention in the specification is camel case.
Naming conventions might differ in subtle ways for different ...
- 103
-3
votes
1
answer
338
views
Is it bad practice to give a directory and a file the same name?
I have a program that produces a command line tool called GetFood. The source code lives in a directory named GetFood/, and I have a main file that interacts with a class that gets the food. It seems ...
- 101
-4
votes
1
answer
117
views
General term to describe the anti-pattern where the same concept is described in different ways?
Our codebase is old and very large. Over the years, many developers have worked on the code and frequently refered to the same concept inconsistently.
For example, we have a "number that uniquely ...
- 140
-5
votes
1
answer
1k
views
Class names with Verbs
So I am reading Clean Code. In the Meaningful Names chapter, they lay down a rule of no verbs in class names. However in the Adding Meaningful Context section of that chapter, on page 29, he uses a ...
