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.
0
votes
1answer
25 views
Where should I log in the user based on http session: service or controller?
I know that best practice is to let everything about authentication/authorization to the service layer.
Controller should not be aware of that.
But how to let a service (from service layer so) to ...
1
vote
4answers
156 views
Is it a good idea to make method behavior depend on the calling thread?
I want to subclass a 3rd party class, in order to make it thread-safe.
I have a good idea of how to implement this, but there is a problem: the superclass has a property, which affects the behaviour ...
2
votes
2answers
93 views
How to define what fields to check for equality?
I have an odd conceptual question, It's not about a specific incident, just a general best-practices approach.
I have asked myself on occasion when defining java Equal methods, what makes two ...
2
votes
3answers
200 views
What is the most readable way of passing arguments to the function? [closed]
I'm using JavaScript but the question can be generalized to all the languages.
In a nutshell - I'm checking if a browser connecting to my site is a microwave and cater for that accordingly.
What ...
1
vote
1answer
148 views
Interface Implementation: A parameter I don't need
Pseudo-Code
interface IPagingInfo
{
int CurrentPageNo { get; }
int RowsPerPage { get; }
...
}
interface ResultsRetriver
{
ResultRows GetResults(IPagingInfo pagingInfo);
}
class ...
1
vote
1answer
124 views
Interface Design: Specific vs General parameter (A Minimal design vs anticipated use variation)
Code
public interface IVehicle {
string VehicleMake { get; }
int MonthsSincePurchase { get; }
bool IsApprovedUsed { get; }
...
}
public class WarrantyPopUpHandler {
virtual bool ...
3
votes
4answers
287 views
Minimal design vs anticipated use
Recently when performing a code review I came across something like this:
Old Code:
WriteLabour(useNewVersion);
WritePart();
WriteNonLabour(useNewVersion);
New Code:
WriteLabour();
...
1
vote
2answers
198 views
What are the justifications for annotations in a programming language? [closed]
After spending a great deal of time writing C# and looking at Java, it seems to me that annotations are just an ugly code smell that introduce another conceptual layer that could easily be replaced by ...
3
votes
1answer
156 views
Cleaner Windows Forms
Backstory:
I am working on a Wizard Setup project and I've ended up with a very big(a lot of lines of code) Form class. Because my form holds a Wizard control which in turn has lots of pages and each ...
8
votes
3answers
714 views
Implementing a complexity hiding layer
As part of the dependencies that the project I'm working on has, we use several core services. These services, to which we can't make big changes, are a big mess. Depending on the method we invoke, we ...
2
votes
5answers
360 views
Are clean coding rules less relevant for large open source projects? [closed]
I've been reading Robert Martin's book "Clean Code". One of his core tenants is to remove unnecessary comments and strive to create meaningful variable/method names that are self documenting.
Some of ...
57
votes
4answers
7k views
Is it better to call a function that doesn't have an effect at that point, IF it improves code clarity?
I have three views in my program (iOS app). Only one of them is ever active at the same time so I set the visibility off for two of them and switch visibility as the user presses buttons. The views ...
1
vote
0answers
65 views
Pointers vs IDs for “context-specific” functions
I need to be able to load, use, and free resources from a single monolithic object. I have two requirements: 1. That the resource loaded is owned by the object that created it and 2. All objects in a ...
1
vote
1answer
263 views
Is writing code chronologically the best way for readability? [closed]
So I've been writing a lot of JavaScript lately. Despite what many people say I think JavaScript can be a simple and beautiful language.
What I've pondered of late is how to structure the code so it ...
8
votes
6answers
3k views
How to reduce a switch in a switch statement?
So I'm making a method to create a salutation line based on two people from a database.
There are four parameters: the two names (name1 and name2) and the two genders (gender and gender2).
For every ...
3
votes
2answers
232 views
How to avoid …Helper or …Manager classes
I have quite a few Helper classes in my project. I have read that this is a bad thing, but I suspect that "Helper" is the wrong suffix for them. I'll give an example.
First, I have a User class. I ...
0
votes
2answers
42 views
Flag arguments in an html factory class
I have been told that flag arguments(boolean arguments) are a bad thing because it complicates the signature of the method and means that the method does more than one thing.
An issue I have with ...
10
votes
6answers
1k views
Best practice boolean assignment [closed]
I came across the following conditional in a program that I have taken over from another developer:
if (obj.Performance <= LOW_PERFORMANCE)
{
obj.NeedsChange = true;
}
else
{
...
66
votes
9answers
8k views
Clean Code comments vs class documentation
I'm having some discussions with my new colleagues regarding commenting. We both like Clean Code, and I'm perfectly fine with the fact that inline code comments should be avoided and that class and ...
3
votes
3answers
181 views
How to best encapsulate features in code and enabling/disabling them at runtime?
I would like to be able to abstract each feature developed by the team in a way that it can be enabled or disabled at runtime by using a distributed shared configuration system. Features are small and ...
1
vote
1answer
97 views
How to name complex DAL/repository methods? [closed]
I'm beginning working with repository pattern. When it comes to simple queries I don't have problems with names.
GetById
GetByDay
UpdateById
If a method retrieves data filtered by two values also ...
0
votes
2answers
352 views
Clean code principles to jquery [closed]
A jquery code could get very long in lines and become an spaghetti code. It could bring problems like chaining functions or many lines for getting data from HTML elements. Also it may create a clutter ...
0
votes
0answers
86 views
Abstract Web API from validation and configuration management in embedded system
Im working with embedded Linux for a router. There is a web GUI for the user to configure router options. When user fill a web form this is submitted to a web server function that is responsible of ...
1
vote
1answer
81 views
Should my program be flawless at release [duplicate]
I'm building a big, very complex piece of open-source software, and it's killing me trying to make what I have as "clean" as it needs to be.
What I want to know is: If there is an undetected flaw in ...
1
vote
4answers
162 views
How to make sure clean code well implemented? [duplicate]
I'm a project manager in a small team of developers (consisting 3 team leaders and 10 programmers)
We're currently trying to enforce clean code for our team , we're having small frequent seminars ...
3
votes
1answer
139 views
Is the target of 3 dependencies per class always achievable?
I'm reading the Clean Code book and a chapter says that if a class has more than 3 dependencies is a code smell of that class isn't doing one thing. Or what is the same, it isn't following SRP. I'm ...
3
votes
3answers
188 views
Development Time: sql in UI code vs domain model with datamapper
First, sorry for my English guys.
Currently this is my first programming job. I am labeled as the most incompetent programmer in my company that's because they measure the performance and ...
1
vote
3answers
370 views
Alternative to goto-statement in this case? [duplicate]
Currently I am using gotos for closing handles and general cleanup if an error occurs.
Since I don't want to nest all the ifs and a function for cleanup would require a return besides the cleanup(); ...
3
votes
8answers
306 views
Creating one-line method for the single purpose of self-documenting code [duplicate]
Given the following two snippets:
Snippet 1:
public void foo(Data data, AbstractNode node)
{
int originalId = data.getCurrentId;
node.execute(data);
//If node changed currentId reset it ...
4
votes
2answers
250 views
Should I use properties for the properties of properties?
Sometimes I use some indirect properties to set or get some other sub-properties,
I give an example
class Page
{
public string MainText
{ set { MainParagraph.Text = value; } get { return ...
3
votes
2answers
301 views
How should blank/empty value objects be instantiated/structured?
I was wondering... what is considered the best practice to instantiate blank value objects? (in Java)
E.g. Assume we have some value object class Foo, that could be blank.
Would creating methods ...
2
votes
4answers
369 views
Two classes that behave identically yet are semantically different
I am writing a program which is a similar to Ruby's Active Record Migrations, in which that every migration has both an "Up" and "Down" in terms of creating a change to the database, "Up" meaning ...
0
votes
1answer
542 views
Clean architecture: should users go in the use case layer or the domain layer?
I recently read this article about Clean Architecture, as I'm trying to get out of some usual OO habits (interface design everywhere, but what does it do???), and program something that describes what ...
2
votes
2answers
91 views
Method for all objects for checking conditions which also includes method chaining and avoiding variables
(I am currently using groovy but it should apply to most OO languages so I also put the langauge-agnostic tag)
I try to program in a function style which also includes method chaining and avoiding ...
0
votes
1answer
55 views
Pretty splitting of lines?
<?php
if (in_array(exec("pboxsvc pboxlib.bin DeterminarTipoSpool' $idJob"),
['IPP','PSFORM','PBSSFORM','PDF'])):
?>
How would you refactor that line to be ...
0
votes
1answer
129 views
More appropriate to validate a dependency filter parameter by mock+stub or by expression compile?
My lead is enforcing TDD on our project. He says he's following Uncle Bob (Robert Martin) and SOLID principles. One of the rules he's reinforcing is what I call "the single cog rule"--there should be ...
0
votes
2answers
292 views
How to avoid spaghetti code when I have a lot of conditions? [duplicate]
I have the following problem:
An user can withdraw money from 2 payment systems (but the number of payment systems can change anytime in the future).
If user has a trusted account on either of ...
9
votes
3answers
926 views
Clean Code and Hybrid Objects and Feature Envy
So I recently made some major refactorings to my code. One of the main things I tried to do was split out my classes into data objects and worker objects. This was inspired, among other things, by ...
1
vote
1answer
112 views
How to keep class parameters visible while using generic argument passing
After writing some classes where class initialization requires multiple options, instead of writing several parameters into constructors or setters, I started passing an associative array of ...
0
votes
2answers
111 views
How to improve code that has to handle list-objects in general and special cases?
I do have an implementation issue that I condensed to the following code snippet, because the real code is much more complicated. The core problem is that I do have a container object that has a mixed ...
0
votes
5answers
460 views
Breaking a function into smaller ones is great… except for what about code-folding? [duplicate]
I'm currently reading Robert Martin's Clean Code book. So far I'm enjoying it.
Martin talks a lot about separating long functions into short functions, each doing exactly one thing at one level of ...
16
votes
16answers
2k views
Do else blocks increase code complexity? [closed]
Here is a very simplified example. This isn't necessarily a language-specific question, and I ask that you ignore the many other ways the function can be written, and changes that can be made to it.. ...
0
votes
0answers
170 views
Better and cleanest way to bind a ICommand to a RelayCommand
By reading various source code, I see that there is different ways of binding an ICommand to a RelayCommand :
From the constructor
MyAwesomeViewModel() {
this._fooCommand = new ...
8
votes
2answers
945 views
Applying the principles of Clean Code to functional languages
I'm currently reading Robert Martin's Clean Code. I think it's great, and when writing OO code I'm taking his lessons to heart. In particular, I think his advice to use small functions with meaningful ...
1
vote
2answers
196 views
How to know whether to create a general system or to hack a solution
I'm new to coding , learning it since last year actually.
One of my worst habits is the following:
Often I'm trying to create a solution that is too big , too complex and doesn't achieve what needs ...
2
votes
1answer
180 views
MVC Controller - keeping methods small
I'm reading uncle Bob's Clean Code and it completely revolutionizes my programming style. In this book author claims that best methods are small methods. What about controller's action methods in ...
5
votes
0answers
182 views
Erlang function naming conventions
I understand the general Erlang conventions for functions are using snake case or camel case, but what about exported functions?
For example, say I have a gen_server module that defines a check to ...
1
vote
1answer
256 views
Equal or less than 15 lines per method(function) principle? [duplicate]
Some books or master told us this principle: Equal or less than 15 lines per method(function), and the perfect is under(or equal) 8 lines.
Does the principle make sense for most conditions?
There ...
2
votes
1answer
213 views
Will this “wireless” syntax for my framework make for good code structure / design?
I'm at the point where I'm getting into the freelance development of some complex web apps, and I would like to develop a light weight framework for my personal use, but I'd like to get some advice ...
0
votes
2answers
374 views
Can this code be made more concise? [closed]
I came across some code recently where in many, many places, expression evaluations were being assigned to different arrays one index at a time. A psuedo-code example:
array[0] = item1[0] + item2[0];
...
