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.
643
questions
-2
votes
1
answer
91
views
Adding new column(s) to DB Table breaks existing queries [closed]
Dilemma: I am working in microservices (MS) architecture for a product with shared (PostgreSQL) DB between MSes and DB Views exposed as Data Access API between SW Components, written and maintained by ...
- 107
23
votes
5
answers
5k
views
Best Practice - Avoid naming class and field the same?
When modeling classes I always have stumbled on the problem that the class has a field with the same name. Look at this example:
class Name {
string meaning;
string language;
string name; /...
- 347
4
votes
2
answers
270
views
Term for type information from C Source Code
I'm writing a code that extracts information about functions (prototype) and types (enum, struct, typedef) from a C source file.
This is to augment the type information about a particular function or ...
- 352
0
votes
2
answers
242
views
Can a UUID be called a constant?
From my understanding, a constant is a value which is assigned only once and cannot change at runtime, whereas variables have mutable values which are unpredictable by nature.
My question is, to what ...
- 53
1
vote
3
answers
267
views
What is the name, or design pattern, for something that calls a list of functions one by one?
The following design emerged from using Azure Durable Functions with lots of fan out, which turned out to not work very well. Our starting point was an Orchestrator with a companion Durable Entity for ...
- 129
1
vote
1
answer
83
views
Self-Selecting Variant of the Strategy Pattern?
I've found this pattern useful, and am trying to classify or name it.
Basically, that:
A task should be performed by different strategies, depending on the context.
Each concrete strategy implements ...
- 113
-3
votes
1
answer
83
views
Declarative name for function with multi-purpose-loop from broken-up monolithic function [closed]
I'm currently in the process of reworking a monolithic function.
My first step is finding blocks of code that can be extracted into their own "sub"-methods for ease of readability & ...
- 97
4
votes
3
answers
522
views
What to name a POST endpoint that behaves like GET?
My app has an API endpoint GET /sessions/{id} which gets info about a session. This endpoint returns a lot of data, so we allow passing JSON in the request body to filter what fields etc. are ...
- 153
0
votes
1
answer
140
views
Best way to name derived classes when extending its functionality [closed]
I have just recently joined a new company and one of the classes used to log information has not been written properly. So I have been asked to add new functionality to the logger.
Rather than ...
- 19
6
votes
2
answers
1k
views
Naming an interface that does something and its opposite
Maybe I'm overthinking about naming, but it's a problem I've encountered several times and it was really annoying every time.
I have three interfaces. The first is IAssembler, which has assemble(...) ...
1
vote
1
answer
169
views
What to name class that applies methods of another class?
This is a pretty vague question, but, sometimes, I'm not very good at naming specific tasks, but I know it's very important and I don't want to name it something ungood.
I have the following file ...
- 119
2
votes
1
answer
1k
views
Naming Conventions for microservices
We are currently splitting up our Intranet monolith into multiple (Micro)services. The layout in itself is already finished and we have decided to split them up in a way that there is only ever one ...
- 239
-1
votes
1
answer
970
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 ...
- 111
0
votes
3
answers
255
views
Should I send the current or previous state with my state changed event?
I have an event that is raised when my job objects change state (e.g. initializing, running, complete, etc). The event is to be invoked from my set method in the State property, but before I make it ...
- 1,165
2
votes
1
answer
289
views
Why is the 4+1 architecture model view named "4+1"?
Why are use-cases counted separately from the other views in the 4+1 architecture?
How are use-cases different from others views?
- 139
-2
votes
2
answers
128
views
Guidance on naming methods that check data quality and then executes logic [closed]
I'm writing boolean methods that do a data quality check and then performs logic. such as isRecordValidAndIsUserPrivilaged. these methods checks the record validity, and then checks the user's access )...
- 183
0
votes
1
answer
54
views
Correct selection of flags for extension
In my library (DLL), I have extensions for List like the next one.
<Runtime.CompilerServices.Extension>
Public Sub Store(Of TVal As IFullyOperable)(items As List(Of TVal), w As BinaryWriter, ...
1
vote
1
answer
2k
views
Appropriate naming for (GitHub) repositories belonging to the same project [closed]
I have some issues selecting an appropriate naming scheme for GitHub repositories that belong to the same project. The main package repo relies on additional repos to generate documentation or run ...
- 137
1
vote
2
answers
97
views
What do you call a process which transforms objects of complex types into simple objects of primitive types? [closed]
My first thought was that I'm "serializing" the complex object, but from what I understand that means I'm reducing it down to a string or binary format which could be passed over a network. ...
3
votes
1
answer
886
views
Naming convention for the classes holding REST APIs [closed]
Our new team suffixes class names with API to indicate that they encapsulate RESTful methods. Eg: "PaymentTemplateAPI", "FeeTemplateAPI" classes. I find it odd since API is a ...
- 149
-1
votes
1
answer
97
views
What should be a method prefix that makes calculation based on the parameter [closed]
I have a method, that takes a list of students, and returns the student with the best score.
Part of me wants to call it Student getBestStudent(List<Student> students), but I think that get ...
- 131
1
vote
2
answers
82
views
Naming for a Class that performs one or more set operations
I'm designing a class that takes:
1 - An initial set of items (a simple collection/list)
2 - 1 or more Filter objects, that take the initial set of items and return a new set. Each Filter object may ...
- 21
0
votes
2
answers
158
views
How to manage ongoing development of two variants of the same library?
I'm the developer and maintainer of a FOSS C++ library, call it libfoo.
There used to be just one variant of it; and I've made several numbered releases. Last year, I've created a second variant of ...
- 2,489
-2
votes
1
answer
72
views
What do you call a function that properly remains undefined?
Backstory:
I have subclasses that are supposed to override and define various functions, but not neccessarily all of them. They can't remain purely virtual though for obvious reasons, and so I am ...
- 3,505
-4
votes
3
answers
984
views
Is there the difference between "symbols" and "characters" in programming?
I want to select between "symbol(s)" and "character(s)" for my variables' names in cases when these terms are synonyms. Please teach me some information which allows to make this ...
1
vote
2
answers
1k
views
Can a class be considered as a factory even though it only creates one concrete type of objects?
I have a simple class called Link that contains some properties, and use different classes for creating different types of links.
My code looks like this:
class Link {
String reference, label, ...
- 225
8
votes
2
answers
706
views
Should function names describe their parameter types?
If you wish to perform the same action using different parameters, you can either make differently named functions:
public Apple findAppleById(long id){
return repo.findById(id);
}
public Apple ...
- 207
2
votes
3
answers
386
views
I need help naming a possible movement in a chess game
I'm working on a chess game and have created a base class for game entities and chess pieces, along with an enum for the state of a square, when returned in a collection of possible movements:
public ...
- 1,165
22
votes
11
answers
5k
views
In a fluent interface with "with", is cloning expected?
In an object oriented language like Java or PHP (other perspectives welcome as well) if I use a fluent interface like this:
my_pizza = (new Pizza).withTopping("pineapple");
another_pizza = ...
- 577
1
vote
2
answers
141
views
API for input stream operation read until
I want to create a stream class The input stream should read/parse a continuous range from left to right providing convenience methods. The implementation isn't a problem but choosing a consistence ...
- 119
2
votes
1
answer
542
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
0
votes
0
answers
79
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 = ...
- 592
6
votes
4
answers
600
views
Is there a standard name (or examples) for the "sandwich" pattern?
I've noticed a certain idea recur in different contexts, but before I start calling it "the sandwich pattern", it would be useful to know (in the spirit of other "Is there a name for ...
- 485
0
votes
2
answers
167
views
What is the best practice to name a method that must either return saved result or resolve it?
Consider the following java code:
public class Foo {
private Bar bar;
....
public Bar xxxBar() {
if (this.bar == null) {
//resolve bar
this.bar = ...
- 137
0
votes
2
answers
143
views
Adjective for being okay to send via an unreliable protocol?
UDP is an example of an unreliable protocol. Is there a single word that means "okay to send via an unreliable protocol?" Sort of like "unimportant", but that's too strong a word.
...
- 2,576
1
vote
1
answer
285
views
Naming for services/workers ect
I'm kind of new to this "separate your methods from models" (yes I was one of those developers). From what I understand I have to separate everything into models, services and factories. A ...
- 121
5
votes
2
answers
2k
views
What naming convention should I use in Clean Architecture?
in the code base of my job, we use clean architecture standards. So we have controllers, use cases, etc. To name them, we follow this template: {name}{type}, where type is one of the following values: ...
-4
votes
1
answer
128
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
4
votes
4
answers
656
views
How name public method that relays to abstract methods of its children (c#)
I've run into the following situation multiple times, and in every case have struggled with the naming.
I want a class to force its children to implement a method, but I want the parent class to be ...
- 1,496
6
votes
6
answers
4k
views
Does using the word "base" in a class name indicate abstraction?
I'm wondering if there is a widely accepted convention for naming base classed in OOP. Does marking a parent class with "Base" indicate that it's abstract or that it's just an extended class?...
- 169
1
vote
1
answer
109
views
Pattern name to compare previous raw values to current values
I find myself applying a certain pattern again and again and I assume I am not the first one. I am looking for a name.
In the environment I find myself in we get updates to values via an external ...
- 129
0
votes
1
answer
143
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
2
votes
1
answer
246
views
What is the name of this pattern / style?
We have a "workflow orchestration" system at work.
It works something like this:
You configure what to run (in a database table), such as:
NameOfStepATHingToRun ="weather_data"
...
- 1,393
-2
votes
1
answer
53
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
2
answers
549
views
Is there a canonical list of standard verbs to use for method names?
I was trying to explain something to a junior programmer the other day, and as part of it I had to explain that:
a method with 'find' as the verb in it, will either find an item and return it, or ...
- 345
0
votes
1
answer
1k
views
What would you name the different DTOs for the methods "GetUser" and "AddUser"?
I have a web service with the methods GetUser and AddUser, and some DTOs (Data Transfer Objects)
GetUser: retrieves user information, as a DTO called UserGet
DTO AddUser: takes a DTO called UserAdd, ...
- 111
0
votes
0
answers
42
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
265
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
4
votes
1
answer
398
views
How to name a domain concept when experts use different terms?
The DDD literature is quite clear that when a word/term has a different meaning for different users, a Bounded Context should be created to be able to separate the domain models.
I'm facing the ...
- 3,563
0
votes
1
answer
36
views
Allowing a client to specify whether parameter is Required or Preferred
I am enhancing an existing API to provide shipping rates for a b2b web service. This specific endpoint returns a single rate based on matching request parameters such as the service level and package ...
- 651