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.
515
questions
-2
votes
1
answer
67
views
Clean code: formatting rules, dependent functions, multiple calls [closed]
About formatting
Here are two scenarios in which the details of the formatting are described.
How should in the clean code way, this be formatted
Scenario 1: Dependent functions of dependent functions
...
- 19
0
votes
2
answers
247
views
Does Clean Code suggest avoiding all base class instance variables (include private instance variables)?
According to Why is Clean Code suggesting avoiding protected variables?, I should avoid protected variables because of the reason : "closely related concepts should not be separated into ...
- 1,043
12
votes
4
answers
5k
views
Is there a clean way to model methods that only make sense depending on the current state of the object?
Let's say that I have a class called Mission. This class is intended to represent a mission requested by a professor working in a faculty. Mission has a private enum field representing whether the ...
- 411
0
votes
3
answers
176
views
Is "the boolean value is from dynamic loaded data (eg:user input, database)" a reason to use boolean parameter?
I know there are some questions about boolean flags: Is it wrong to use a boolean parameter to determine behavior?, Multiple boolean arguments - why is it bad? which indicates the following code is ...
- 1,043
3
votes
2
answers
543
views
How can I nicely pass on a class instance in python?
I am rewriting a streamlit app that is an interface to a laboratory management system (LMS). This means, that I have to make a lot of requests to that LMS through its python library (PyBIS). The way ...
- 203
1
vote
4
answers
105
views
Add new condition or create a separate method?
At first I had the following logic of user creation:
class UserService {
constructor(userRepository, postRepository) {}
createUser({user}) {
this.userRepository.create(user);
}
}
Then I ...
- 127
3
votes
2
answers
613
views
Key difference between Hexagonal Architecture vs Clean Architecture?
I am trying to improve the architecture for my React app project that has grown in size lately.
I'm looking at Hexagonal architecture and Clean architecture, and I couldn't really see the difference ...
- 31
-1
votes
1
answer
119
views
How to integrate business logic from Domain layer with UI
I have a rich client with quite complex domain logic and I want to keep the domain and presentation layer separated. How would you advice to intergrate the domain logic with the UI in this case.
I ...
- 141
0
votes
1
answer
90
views
Should you add the name of the package to the module/package name in Python? [closed]
I'm looking for some best practices for readability (and clean code in general) for naming modules/classes within more extensive projects. More specifically, is it reasonable to add the package's name ...
- 117
0
votes
4
answers
193
views
Should we create a new function for every multiple conditions?
I have the existing code provided below:
if (!$existing_records && !$has_required_field) {
return 'Skip Update, no records found';
} elseif (!$existing_records && $...
9
votes
4
answers
3k
views
Is it okay to have misleading struct and function names for the sake of encapsulation?
I'm writing this library in which the user can provide custom code defining the algorithm used for finding an optimal solution. In the papers that I have read, the targeted user thinks in terms of ...
- 411
37
votes
11
answers
10k
views
Multiple boolean arguments - why is it bad?
This seems to be a commonly encountered and brought up code smell, and is a common feature in multiple coding design books which I wasn't fully able to understand.
Say I have a function
def ...
- 481
1
vote
1
answer
245
views
Working with a poorly written piece of software as an entry-level developer with no support or documentation [duplicate]
I'm and entry-level developer straight out of college. I am the only developer at this company.
I feel the challenges I face are different to most people working with sub optimal or very poorly ...
- 41
18
votes
10
answers
6k
views
Code readability and debugging
Sometimes, I have a hard time deciding between two good code traits: debuggability and readability. The snippets below are an oversimplification, but they illustrate my pain.
Example 1:
if(...
- 423
0
votes
2
answers
225
views
How to refactor this tightly-coupled method and (mostly) preserve its encapsulation?
I have recently encountered this problematic method (minimal reproducible sample in C++ but this question aims to be language agnostic past the syntax):
void MyObject::twice_bind_cycle() {
_bind1()...
- 17
0
votes
4
answers
278
views
Object matching using generic method? [closed]
I have a piece of code where two objects (incoming request object and a profile object) are to be checked for matching conditions.
So the first method is as below where I check whether the profile ...
- 593
3
votes
3
answers
747
views
How to write effective automated tests when building GPT4 powered software?
Part of my current product uses GPT-4 with a prompt to extract information from plain text. As behaviour of large language models is inherently opaque and failure cases unpredictable, I was wondering ...
- 65
0
votes
1
answer
74
views
Avoiding repeating code when assigning pointer addresses based on branch
I have the following code in C that reads data off a char array and makes decisions on what variables should some pointers point to.
char preset1[20];
char preset1Name[20];
int preset1Temp;
int ...
- 151
0
votes
0
answers
30
views
Android, are seperate state update functions a DRY violation?
In my ViewModel I’ve implemented couple of functions to manipulate the state of my UI. It quickly becomes bigger and bigger and I wonder if these functions violate the DRY principle? I could wrap it ...
- 101
3
votes
1
answer
137
views
Composite repositories: minimizing dependency injections
I have an application with dependency injection that consumes a REST API. The API calls are abstracted into entity-specific repositories. Some of the repositories are: HttpNotebookRepository, ...
- 101
0
votes
1
answer
274
views
Separating Application (Business Logic) Layer to Multiple Module Layers in Clean Architecture
Currently, I'm designing the Project based on Clean Architecture composing with 4 layers:
Domain
Application
Infrastructure
Presentation
Since the project is pretty huge, I'm now considering to ...
- 125
-1
votes
1
answer
126
views
What is point of having certain microservices making another API call in the same service
I was going through an old, largely untouched part in my company’s codebase and found one API. It does the following things.
A POST API with path host/entities/trigger which fetches a list of entity ...
- 11
1
vote
2
answers
119
views
Best practice for updating object fields (with values calculated in methods)
What's the cleanest and most coherent way to assign a new value to an object field when the calculation of that value is outsourced to another method?
The most obvious way would just be to update the ...
- 139
1
vote
2
answers
474
views
Software Design: Decoupling when highly dependent on a third party library
As part of an university project I am currently working on an eeg-biosignal classifier. While the project itself doesn't really focus on design ("anything that works") I am trying to learn ...
- 21
0
votes
2
answers
255
views
Is there some easy way to refactor deeply coupled python code
I recently took on a long ago python project which has some weird code style that I can't pinpoint. e.g.
# this is a params and value package?
opts={
infile="xxx",
outfile="xxx"
}
...
- 111
1
vote
0
answers
156
views
Typescript Clean Architecture: How to tackle use case that needs multiple repositories?
I am implementing clean architecture in my new back-end project and getting stuck with a particular use case.
I have a CreatePhysicianUseCase what is responsible for creating a new physician user in ...
- 129
-1
votes
1
answer
103
views
Using helper libraries to improve readability and conciseness of code vs adhering to native functions
currently in my place of work I'm headbutting with some coworkers from other teams (but same repo), since they are in a line of thinking where they prefer this:
const connectionList = Object.values(...
- 167
1
vote
4
answers
297
views
Looking for a sanity check, do you alphabetize your code? Is that even a thing? [closed]
I'm currently working with a group of developers (as outside contractors) on an existing codebase (in kotlin) and the lead dev (the client) is blocking merging of pull requests (GitHub) because ...
- 127
1
vote
3
answers
113
views
Separating network logic from business logic
I am creating a simple P2P file sharing system, where one peer can send some Objects (e.g., String, custom objects, etc...) to another peer.
The peer, that receives the Object, can then manipulate it, ...
2
votes
2
answers
209
views
Should I abstract function calls with duplicate arguments?
I have an intuition, that I'd like to read what others have talked about. To me, it seems fairly intuitive that when you have a function which is called multiple times with the same arguments, it ...
1
vote
3
answers
865
views
Const function that change other objects' states
Is it a good idea to mark a function const from clean code perspective if it change other objects' states? I'd like to know what is the experience with this or is it considered a bad practice for any ...
- 129
0
votes
1
answer
193
views
Where to create repository instances?
I've several repositories. To make them testable, I add the ORM session in the constructor.
class Repository:
def __init__(session):
self.session = session
def save(object):
self.session()...
- 143
0
votes
3
answers
1k
views
Optimizing a string to enum converter [closed]
I have built a string to enum converter, which converts a known set of strings that it receives into enum, in order to satisfy a function pointer. Some of you may recognize some elements of this ...
- 151
3
votes
5
answers
2k
views
Alternatives to if-else on data reading
I have some code on Arduino (so, written in C++) that receives a String through the UART terminal, reads the String, then decides what String to print back and how many things to print depending on ...
- 151
1
vote
2
answers
594
views
Modules Design and Communication Between Them
I'm trying to design a monolithic application following DDD and clean code. Lets say I have Users, User Types, Products, Product Types and Purchases. I want to implement using different modules.
At ...
- 41
0
votes
1
answer
559
views
Clean Architecture for React App: Component / View / Page
Abstract
I'm trying to figure out a solid, scalable, clean and practical architecture for react projects.
As a a playground I have a project with two Screen and a JSON server.
When I try to apply a ...
- 207
2
votes
4
answers
2k
views
Code smell java:S115 - Constant names should comply with a naming convention
In my Java 11 / Spring Boot codebase I have enums that don't respect the convention to have all uppercase constants because when we move to frontend the data there has to be camelCase (or even random /...
- 141
1
vote
1
answer
318
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
1
vote
1
answer
745
views
How to avoid argument drilling when subdividing functions?
As suggested by Uncle Bob in his book "Clean Code", I am actively trying to keep my functions small and readable.
However, I often encounter arguments drilling when I try to refractor a big ...
- 19
-1
votes
1
answer
1k
views
Clean code about constants in Python
My question regards to constants in Python. Which is more "convenient" or "acceptable" among software engineers in general:
Putting classes of constants in another file called &...
- 1
0
votes
0
answers
47
views
Refactor conditional multiple AND OR operations? [duplicate]
I have a piece of code where two objects (incoming request object and a profile object) are to be checked for matching conditions.
So the first method is as below where I check whether the profile ...
- 593
3
votes
2
answers
437
views
What is the alternative to checked exceptions in API/interface design?
Despite checked exceptions being generally bad practice and anti-pattern, I find one feature very useful: having list of checked exceptions part of function signature.
Checked exceptions are "...
- 139
0
votes
1
answer
854
views
Clean code and SOLID principles in WPF/MVVM view models?
I'm currently reading "Clean Code" by Robert Martin (which I should have read years ago), and it's given me a bit of a wakeup call, especially regarding keeping methods and classes small, ...
- 1,115
0
votes
1
answer
152
views
Verbs in Use Case name "Create User" [closed]
I'm struggling on how to name classes for use cases. Because I know that is "bad" to use verbs in classes names(Uncle Bob) but at the same time names of use case classes should explain what ...
-4
votes
1
answer
518
views
Pass a value to a class via a constructor or a method? [closed]
I'm newbie in Java and I have question. Pass a value to a class via a constructor or a method?
public class HelloWorld{
public static void main(String []args){
TextModifyFirstVersion ...
- 3
7
votes
6
answers
420
views
Can Data Abstraction Violate the Interface Segregation Principle?
I'm reading Clean Code
In Chapter 6, Objects and data structure
First talk about Data Abstraction:
Hiding implementation is not just a matter of putting a layer of functions between the variables. ...
- 187
7
votes
4
answers
3k
views
How to model 1 to many relationships in DDD (Domain Driven Design)
I think I am struggling to model a relationship between 2 entities. I am trying to do so in a way that promotes DDD and captures business semantics. The following is my business context:
I am ...
- 223
2
votes
2
answers
316
views
Should you create your own Interface for all (most/many) Api Calls? (Adapter)
I am currently reading Clean Code by Robert C. Martin and in Chapter 8: Boundaries one can find this paragraph:
We wanted to tell the transmitter something like this:
Key the transmitter on the ...
- 239
32
votes
6
answers
7k
views
Do inline expressions obstruct readability of code?
Currently, I'm reading "Code Complete" by Steve McConnell, 24.3 chapter "Specific Refactorings". I've become kind of confused with 4th paragraph, that looks like:
Move an ...
- 1,015
0
votes
2
answers
715
views
Is this a case where 'else' is inevitable?
I am writing some code that enables / disables a certain kind of hardware function. To enable it on, I have to call some methods, and to disable it, some others.
Of course I want this code to be clean,...
- 779