Questions tagged [clean-code]
The term "clean code" is used to describe computer programming code that is concise, easy to understand, and expresses the programmer's intent clearly. Questions with this tag relate to the process of writing clean code, or refactoring old "dirty" code to be clean code.
499
questions
1
vote
5
answers
1k
views
Clean code for multiple entity representations
I'm wondering what is a clean solution for representing an entity in many different format.
Let's suppose I have the following entity:
Person {
Long id;
String title;
String firstName;
...
- 147
0
votes
2
answers
121
views
Tool or strategy to remember code structure and where I left [duplicate]
I am working on multiple projects as a developer and second line support, It happens that I fix a bug on one project, test and deploy the change then leave the project for months and return back for ...
- 241
7
votes
2
answers
5k
views
Should one make the database calls in the constructor or method of a class?
Take the following instance for example:
CreditCardApplication class
public class CreditCardApplication
{
public int Id { get; set; }
public string FirstName { get; set; }
...
- 291
7
votes
5
answers
1k
views
Refactoring: Replacing a temporary variable with a query. Is this code example bad practice?
Before I ask my question, I want to note that this is not my own code; it comes from the Refactoring Guru website:
I often find myself using the code on the left, and I have one primary motivation ...
- 181
1
vote
4
answers
407
views
How would I add up enumerator values such that any combination provides a unique number?
Backstory (You can skip)
I am writing a pronunciation library for irregular words. Take something like the following:
T1E1s // tee one E one es | tee one E ones
1994-1995// 1994 (minus|dash|to|) ...
- 3,505
1
vote
1
answer
103
views
How should I integrate routine history tracking feature with the routine itself
Let's say I am writing code to run a machine similar to a 3D printer and I have a routine like:
machine.moveTo(x1, y1);
machine.alignByCamera();
machine.heatUp();
machine.extrude(amount1);
machine....
- 21
0
votes
1
answer
333
views
Controller or application service making HTTP Requests
I'm in the school of thought of 'thin controllers', and love to push logic down into services and the domain models. However, I'm wondering if my controller should be making an HTTP Request to another ...
- 1,189
110
votes
13
answers
21k
views
How do you justify more code being written by following clean code practices?
Moderator note
This question has already had seventeen answers posted to it. Before you post a new answer, please read the existing answers and make sure your viewpoint isn't already adequately ...
- 843
3
votes
1
answer
857
views
How to (or should I) refactor RxJS nested subscriptions with intermediate return value?
I hope this fits more here than SO because it is mostly about code design than making it work. Also, this is not tied to RxJs, but more to the reactive paradigm. (TypeScript tag is only added to make ...
- 212
8
votes
2
answers
10k
views
Doesn't repository pattern in clean architecture violate Dependency inversion principle?
From what I have read and seen clean architecture assumes that you have some entities which know nothing about persistence though at the same layer as they reside there might be an interface which has ...
- 191
2
votes
5
answers
2k
views
Declaring unnecessary variables for readability
I know some languages (C comes to mind) its best to declare as few variables as possible. In a language with memory management like C# is it better practice to continue with this philosophy or should ...
- 157
0
votes
1
answer
130
views
Is a "concrete function" over "generic function" a good implementation?
I want to know others opinion about this approach that I use in a lot of projects, for example, I can show the last time that I use it:
public class DataStorageService {
private enum Keys {
...
- 387
12
votes
6
answers
3k
views
Passing Objects vs. Primitives
What is the best practice when it comes to passing variables around? Is it better to pass objects (models) or is it better to pass primitives that will be required by the called method? What are the ...
- 257
3
votes
2
answers
184
views
How to improve code quality in database driven applications
I'm working for a company with a big ass legacy codebase. Changing existing code is like a guarantee to break things. Most functions are a few thousand lines, using some global flags, having different ...
- 133
4
votes
1
answer
341
views
Dynamic Object Abilities When Saving State
I have n classes that extends from a State class, the purpose of the State class is to manage the state of the extended classes. For each class we need to save it in the database, remove it and select ...
- 141
0
votes
1
answer
318
views
use always get and set methods is a bad practique, is call directly an attribute class a bad practique in OOP?
I have a doubt about if there are some recommendations for call directly an attribute in a class
I think that in OOP you always should call an attribute by the get method.
For example:
On set
...
- 387
10
votes
4
answers
2k
views
is this way of calling a function a bad practice?
I have the following code:
public void moveCameraTo(Location location){
moveCameraTo(location.getLatitude(), location.getLongitude());
}
public void moveCameraTo(double latitude, double ...
- 387
5
votes
2
answers
751
views
How to use single responsibility with functions when I need to reuse procedures?
I've just read the book called Clean Code. The author (Robert C. Martin) talks about a single responsibility that a function should have in a program. It should only do one thing.
Now, I would like ...
- 59
5
votes
1
answer
14k
views
Declaring constants: one file or separate?
I currently have a small list (< 20) of constants that can be segmented into the following three parts:
- main script (tokens, log file location)
- database setup (username, passwords)
- API (API ...
user146112
2
votes
3
answers
422
views
In c++, is there a way inside a function block, to execute cleanup code after the value has been returned?
Backstory (You can skip)
I am building an API for managing Files and Directories in a consistent manner across a project. This is for deduplication and consistency when performing a task, and in this ...
- 3,505
1
vote
2
answers
252
views
How to find already existing code | How to arrange code in a way it can be found again [closed]
I'm refactoring the framework of our company, trying to fix the issues we had in the past.
We're a team of 6 developers, and we have various needs and issues in regards to tidying up our framework.
...
- 2,153
1
vote
4
answers
650
views
Can method names give any implementation details and break encapsulation?
I was reading here about OOP and methods, and the accepted answer states that method names should be verbs. However, that doesn't really answer my question.
Suppose if I had a Character class with a ...
user327264
4
votes
2
answers
105
views
How are settings structured when they can be configured in diffferent ways?
Suppose of this question the following:
I'm in full control of this project
I'm writing a media player
Obviously, a media player will allow a user to adjust the volume, so I might have a class that ...
user325735
9
votes
1
answer
1k
views
What does "TILT" mean in a comment?
I'm reading Clean Code by Robert C. Martin, and the phrase TILT inexplicably appears in some code samples. Example (it's in Java, by the way):
...
public String errorMessage() {
switch (...
- 201
0
votes
5
answers
2k
views
Is using the Pair class a sign of primitive obsession code smell?
Let's say I use a Pair in this way:
Pair<Long, Date> signup = getSignup();
System.out.println("User with ID " + signup.getLeft() + " signed up on " + signup.getRight());
Is it a form of ...
- 111
0
votes
2
answers
270
views
How compatible are data science notebooks with clean architecture?
Clean architecture decouples an app's core from the presentation/UI layer. The UI is just a plugin, replaceable (eg, web-based to desktop) without impacting the core.
Many data science apps mix code, ...
- 803
2
votes
4
answers
656
views
Clean code vs clean git/jira history
I started reading the book Clean Code by Robert C. Martin and at the start I found this idea of his interesting, "Leave the code cleaner than you found it" adapted from the "Leave the campground ...
- 142
2
votes
4
answers
601
views
What is a good place, in OO, to store a string that is used many places?
I have a string that is used in a few places.
string portalLoginPath = $"{Request.Scheme}{Uri.SchemeDelimiter}{Request.Host}/Account/Login";
I was thinking of creating a static class with a string ...
5
votes
2
answers
3k
views
Clean Code: Another question about boolean as function parameters [duplicate]
I had a discussion, if the code for calling information from a database can have a switch to show also deleted entries.
Simplyfied the code (C#) look like this:
void searchEntry(string searchValue, ...
- 161
6
votes
3
answers
5k
views
Is it a good idea to share repositories across microservices in Spring Boot Application?
We are migrating a desktop application into web based Spring Boot micro services application with a client imposed mandate of using their existing MySQL database, so all micro services share a common ...
user322492
0
votes
1
answer
1k
views
Java convention - Implementing two similar functions for two different objects
I have two classes, let's call them Foo and Bar. They both extend different classes (Foo extends X, Bar extends Y), which have some common ancestor "way up" the inheritance tree, something like this:
...
- 103
0
votes
1
answer
3k
views
Unit testing protected methods which have no reason to be public
I need to make a sponsorship system with complex business requirements. Basically, after a user makes a payment, the system should get triggered. There are many different types of sponsoring, so I ...
- 1,691
2
votes
3
answers
737
views
Always return the parameter when it has changed inside the method?
When you have a method that is doing stuff and changes occur in the parameters, should you always return the changed object like this:
public SomeModel DoSomething(SomeModel someModel) {
[something ...
- 131
0
votes
2
answers
743
views
Uncle Bob's clean architecture refactoring techniques for data objects / entities / LINQ queries
I have relatively simple controller logic with ugly parts of object creation. Some of the objects are really huge and even though all the controller does is to return the object, it looks messy and ...
- 141
138
votes
17
answers
14k
views
How do I know how reusable my methods should be? [closed]
I am minding my own business at home and my wife comes to me and says
Honey.. Can you print all the Day Light Savings around the world for 2018 in the console? I need to check something.
And I am ...
- 1,555
3
votes
3
answers
177
views
One try/catch for each error, or one global try catch and switch error?
I have multiple methods that could fail, let's say :
readFile()
parseFile()
compute()
Each of them could fail (e.g file not found, wrong file type, wrong data), should I put each of them in their ...
- 319
9
votes
2
answers
245
views
fall-through switch for executing a sequence of steps
My program needs to execute a sequence of steps from start to end. But based on different input the start point will vary, e.g, some will run from the first step to end, some will run from the 2nd ...
- 3,077
3
votes
3
answers
347
views
what is the best way to write a recurring code with different enums
Basically what this code does is to determine whether the user is allowed access to the page or not from list of pages as enum, each one has the role name as its name and the page name inside it.
The ...
- 133
-1
votes
2
answers
478
views
How to ensure separation and inward dependencies between architectural layers in Python?
Suppose a large-scale project is being developed in Python 3.7. Some layered architecture is chosen: "clean architecture", "onion" or "hexagonal". The Dependency rule in it only allows inward-...
- 803
104
votes
9
answers
20k
views
Why should I use dependency injection?
I am having a hard time looking for resources on why I should use dependency injection. Most of the resources that I see explains that it just passes an instance of an object to another instance of an ...
- 1,045
2
votes
3
answers
2k
views
Convincing a development team to use a better design pattern [closed]
I recently joined a company where I was tasked with building a system for one of their clients. The work I've done is so far working well, but the most senior developer on the team who's been with the ...
- 139
3
votes
1
answer
1k
views
How do I use polymorphism instead of instanceof?
I'm trying to make an abstract board game. In the game, a player can choose to make multiple actions within one turn such as placing, moving, or rotating a piece. I'm not sure if whether or not my ...
0
votes
2
answers
129
views
Is there a coding style principle for making class usage consistent
I get to review code that often looks like this:
class MyClass1 {
constructor MyClass(initialiseParam1: Object) {
// do something with initialiseParam1
}
initialiseStep2() {
...
- 189
0
votes
1
answer
141
views
How to model either relationship?
I am working on a project where a user can send email to either a contact from his directory (Internal) or type an email address explicitly (External Contact) or a mix of both.
We also show the read ...
2
votes
1
answer
158
views
Is "equivalent" functions / methods readability worth its maintanability cost?
First of all, I am sorry if it is a duplicate, I could not think of any "correct" wording to search about this.
Second let me clarify: By "equivalent" I mean methods that are meant ...
- 31
1
vote
1
answer
97
views
Change request of a behaviour implemented deep in the call stack but is configured in the first calls
Problem: I have a complex system with many layers of abstractions. I need a different behaviour low in the abstractions, but to be configured high in the abstraction.
Solution 1: Having a parameter ...
- 189
17
votes
1
answer
10k
views
Access multiple entities in repository - clean architecture
I have a API call that returns a list of Payments, each Payment contains a User. I need to call it, save the results in the database, fetch all the payments and users and return them all to the ...
- 181
14
votes
6
answers
3k
views
Clean Code - Should I change the literal 1 to a constant?
To avoid magic numbers, we often hear that we should give a literal a meaningful name. Such as:
//THIS CODE COMES FROM THE CLEAN CODE BOOK
for (int j = 0; j < 34; j++) {
s += (t[j] * 4) / 5;
}
...
- 265
0
votes
1
answer
1k
views
Clean Architecture and MVC controllers + entities
In Uncle Bob's clean architecture, why can't MVC controllers call entities directly? It seems like since the controller depends on the inner layer, they should be able to call entities when needed. If ...
- 119
0
votes
3
answers
193
views
Updating nested entities with constraints without getting spaghettimadness
I have an endpoint "import" that is supposed to accept an entity. This entity can contain several sub-entities with yet again some sub-entities. Since this is an "import" endpoint, some of the entites ...
- 119