Questions tagged [programming-practices]
Programming Practices are the commonly or not so commonly used practices in development of software. These can include things like Agile Development, Kanban, Coding shortcuts, etc.
1,592
questions
0
votes
1
answer
89
views
Testability when API contract is fixed
Recently, I spoke to an Engineering Manager about some work I've done:
I had to implement a micro-service to a third party API contract (that they will call). Part of the requirement is to ...
- 141
0
votes
0
answers
53
views
Web application having database with OPC client
I'm designing a browser-based application that will display real-time data collected from OPC server. I have decided to use Angular framework for the browser application development. The browser ...
- 9
0
votes
3
answers
137
views
Use of environment variable or appsettings as a counter, good or bad practice [closed]
I'm wondering if it's bad practice to have a variable in a webserver which counts the amount of incoming requests and put it in an environment variable.
In C# for example you have System.Configuration....
- 383
0
votes
1
answer
106
views
Best practices for minor changes to packages that are no longer maintained?
I'm writing a python package that depends on a relatively old library that breaks in a very specific case: when running a container in read-only mode, a .wh..wh..opq file is added to a directory where ...
- 11
-2
votes
1
answer
255
views
Are there good practices or even conventions to store LLM prompts I use while coding?
I sometimes use some language model assistance (e.g., GPT-4o) while coding. I'd like to save somewhere the prompts and language model versions I used. Are there good practices or even conventions to ...
10
votes
4
answers
4k
views
Is there something between Debug and Release build?
Specifically with CMake builds, if you don't specify a build type explicitly, the build will use neither Debug nor Release compilation flags.
I was writing my own Makefile for a simple program and ...
- 231
-3
votes
2
answers
421
views
Is throwing an error in programming is good Idea at all? [duplicate]
I am wondering if throwing an error in programming is good Idea at all ?
While programming we throw error when something unexpected or invalid has occurred. But if we have thrown exception and it is ...
- 105
1
vote
2
answers
146
views
how best to take a vertical slice of something already trivial?
Lets say I have a project which is something relatively simple like a copy checker for legal text files stored in git, that multiple people contribute to via pull requests that must be reviewed before ...
- 135
0
votes
1
answer
182
views
Is immutable objects over POJO in general?
Lombok is used in the legacy project where I am currently working for since last year. The project is legacy with 10+ years, and POJO/JavaBeans, i.e. @Data annotated classes, have been widely used for ...
- 1,871
0
votes
4
answers
186
views
How to eliminate repetition in three subclasses: each defines an identical method that does almost the same thing, but with a different return type
TLDR:
I have three subclasses, each inherits from the same parent class, each defines an identical method that does almost the same thing, except that each of these methods has a different return type....
2
votes
2
answers
516
views
Is trunk-based development viable for SDK development?
Is trunk-based development (TBD) viable for development of software where versioning, compatibility, long term support and service level agreements (SLA) play a big role for business (e.g. libraries, ...
- 181
-1
votes
1
answer
88
views
Is there any benefit/viability to sharing models across API versions that have differing schemas
I have been asked to get involved with a Team that is currently having delivery issues for various reasons. During my review I came across an acceptance criteria on a user story;
If you call v1 of ...
- 303
5
votes
5
answers
747
views
Is it bad practice to use nullptr in ternary operation?
I've set up a ternary operator in place of a pile of if-else's, the final expression being nullptr in order to finish the loop, like so:
int menuSelect;
std::string operation="";
(...
- 61
0
votes
5
answers
294
views
When, if ever, should a private member variable, used in one function, be made into a local static variable?
Lately, I have been playing with this idiom:
Changing a private member variable into a local static variable when:
member to singleton class used in only one function
member is mutex for a shared ...
- 3,613
2
votes
2
answers
299
views
When to prefer print over logging?
Generally print statements are frowned upon in favor to logging. But are there any situations where I should prefer using print statements?
In a interactive command line application, if I ask for user ...
0
votes
1
answer
202
views
How best to share common steps between services while allowing them to provide their own behaviour
I've started working on a C# codebase. There are three services which run the same set of steps of three kinds of objects, each returning IResult:
public IResult FooService(Foo foo) { ... }
public ...
1
vote
3
answers
266
views
What is the code smell called when API are encapsulated many times [closed]
In legacy code bases, some APIs might be encapsulated by different developers with separate classes many times. Example:
public void calculate(int baseIncome) {
revenueCalculator.calculate(...
- 1,871
26
votes
8
answers
6k
views
What is a good way to indicate that a number is not something you can count with?
What is a good way to indicate in programming that the sequence of digits you see is not a value you can do math on?
I use a lot of numbers which aren't "numbers". From account-numbers to ...
- 13.3k
-1
votes
1
answer
167
views
Help in understanding if my design getting complicated [closed]
I have 3 classes
class Backup
end
class Database
end
Class App
end
The backup database has a reference to Database and App, like
class Backup
def getDatabase
Database.create
end
def ...
- 109
1
vote
3
answers
354
views
Scala Option vs. conditional branches
If I'm writing Scala functions and have to check for nulls in situations where I can't avoid it (say, working with Spark UDFs and some legacy Java types), is it better to turn things into Option or to ...
- 1,339
3
votes
5
answers
440
views
Business acronym usage in source code
What are the rules about acronym usage that are related to the business ?
I always hesitate between using the acronym or not. When talking with people who work here they will understand faster when I ...
- 59
2
votes
3
answers
234
views
Correctness of an implementation beyond the methods signature contract of an interface
Is there a programming principle/guideline that tackles the correctness of a implementation beyond the methods signature contract of an interface?
Let's say we have a repository interface with two ...
- 53
1
vote
4
answers
2k
views
I wrote a class with "init" method. Should I call it from other class methods? Or leave it to the object user? (Code Design)
I have a java class with an init method. It's different from the constructor. The constructor just initializes the variables/fields. The init method connects to a database and performs some ...
- 121
1
vote
0
answers
92
views
What is the best way to implement the following type of paradigm?
I have the following piece of code. Line 1 is a container (for simplicity, one can think of it as a list of elements e1, e2, ..., en). Now there is a function function_fun which takes as input an ...
- 19
-1
votes
1
answer
102
views
How can I prevent an object from being re-sanitized everytime it is passed as input to a function?
Suppose that I have a class named CharStream
Additionally, there are a large number of functions which convert their function input into a CharStream
def funky_the_function(_input):
input = ...
- 145
23
votes
6
answers
6k
views
How important is it to clearly understand requirements and architecture before starting to code? [closed]
Whenever possible I have been requiring an understanding of the requirements and architecture for the next scope of work before starting to code.
Sometimes due to schedule pressure on larger projects ...
- 377
1
vote
4
answers
324
views
Storing both a compiled service for a Docker container as well as the container in a repository. Good practice, bad practice or no precedent?
This has erupted from quite a turbulent meeting between two senior developers, a lead developer and an engineering lead, and after 90mins reached no resolution.
We create Spring Boot Java services ...
- 352
-1
votes
1
answer
94
views
Verifiable Credentials Wallet
I'm working on a project that requires the use of verifiable credentials, and I'm looking to build a wallet that can store and manage these credentials according to the W3C standard. However, I'm ...
- 99
3
votes
3
answers
619
views
How do you go from specification to implementation in a systematic way?
This sounds like a newbie's question, but please bear with me. I have 10+ years of commercial software development experience, and I still don't know how to do this properly.
I'm working on a pet ...
- 284
2
votes
3
answers
414
views
C# Duplicated usage of an if/else condition and a ternary operator. A good practice?
I had a debate with a work mate regarding the following code as to which one of it would be the better practice:
My code (in pseudo):
var A = <precondition either TRUE or FALSE>;
var B;
if(A)
{
...
- 29
3
votes
0
answers
158
views
Forgetting about the utils [closed]
Let's say my language's standard library does not include TrickyFunction(). Since implementation seems quite trivial for me, I decide to create utils in the project and add such function, for others ...
- 217
-1
votes
5
answers
530
views
Proving program correctness under all possible cases
There are techniques of proving program correctness under all possible
cases, but that is a more advanced topic, for a later subject in your
curriculum.
I always had this doubt:
Is it possible to ...
- 25
0
votes
2
answers
84
views
I've a doubt regarding Environment Model of execution
I came across Environment Diagrams,it is described below
Whenever Python needs to work with an object, that object is stored in
memory; and, additionally, Python also needs a way to associate names
...
- 25
0
votes
3
answers
725
views
Why isn't a counter used to avoid nested for loops for index based operations?
Let's assume we have a method that we want to run as fast as possible and it needs to loop on a 2D array, naturally we would do a nested for loop as such:
int[][] arr = new int[3][3];
for(int ...
- 51
-1
votes
1
answer
13k
views
@Getter, @Setter vs @Data in lombok? [closed]
So I was sending code for review and approvals for some changes I made recently. that includes a class as below:
import lombok.Getter;
import lombok.Setter;
@Getter
@Setter
public class ...
- 181
25
votes
13
answers
10k
views
How much time should you spend planning a commit before writing code?
At the moment I'm spending more time planning out a commit than actually writing code when adding a new feature. Less than two hours would be lucky, and sometimes I'd spend a good part of the day ...
- 411
1
vote
2
answers
303
views
Is it a bad habit to use other class' "private" variables in Javascript
I've gotten this idea in my head that i shouldn't use a libraries variable, if the variable name begins with '_', as it is standard to write private variables that way.
But now i'm thinking i'm taking ...
- 143
0
votes
2
answers
2k
views
Store static data in public folder as json file or directly in .js file?
I'm busy working on a website – somewhat new to this – and I don't quite know where I should store static data: in the public folder as a separate json file, or within the .js file as an object.
In ...
- 105
1
vote
3
answers
320
views
What does it mean for a version a programming language to not be supported anymore?
I am fairly new to programming; I was following a tutorial that was using php 7.3.8. So I went to the documentation website of that same php version, and it says it’s no longer supported. So, I ...
- 23
4
votes
2
answers
968
views
How to organize a chain of functions that share parameters, functional programming
When trying to follow a functional programming paradigm, I often find myself in a situation where I have a chain of functions that I would want to combine/compose somehow, but they all also take in a ...
- 413
-1
votes
3
answers
743
views
Would Injecting dependencies in C# as default parameters be a bad practice?
Given the (old) debate over whether Singletons are overused/abused/are worth it - would it be a bad idea to inject the dependencies as default parameters? In this way, we could get rid of defining ...
- 471
0
votes
1
answer
971
views
How to handle config/env vars in a library project
I am building a new Python library project to be consumed by several of my application projects. The existing code consumes environment variables for various configuration settings. Should my ...
- 183
2
votes
1
answer
1k
views
Does it make sense to use byte instead of int in Java? [duplicate]
Recently, I had to implement a business rule in a certain project. The rule basically consisted of checking a range between 1 and 12, values that would be used later, in some way, with Bootstrap.
...
- 69
0
votes
2
answers
728
views
Best pattern/practice to execute a multi-step code generation process
I am working on a project that generates an API with the possibility of doing CRUD operations based on a high-level description of the resources that the user would like to have in an application. In ...
-1
votes
2
answers
240
views
Do I really need TaskManager class? [duplicate]
Background:
I'm coding an app, the core idea is simple - I can choose a 'Task' (consists of name, code to perform aka Runnable, progress) through GUI, start it, stop it, start all 'Task's and stop all ...
- 33
0
votes
1
answer
164
views
When to Push or Publish
I'm in the process of redesigning our entire process control system (a daunting task, really!), and want to make the right decisions to how each system in the ecosystem communicates with each other.
...
- 113
-4
votes
3
answers
176
views
is it bad practise to go back to your last backup when you encounter an unneccessary bug? [closed]
I find when I am programming and I fix a bug in one area of the codebase, sometimes something slightly related or maybe unrelated breaks, and as a result I usually copy and paste the fix to a ...
- 93
-1
votes
1
answer
171
views
Reducing Server Calls or Improving Server Response Times?
In the company I am working for, we have been told to keep server requests to a minimum. There are probably reasons for this specific to the company, but it made me wonder.
Let's say I am building a ...
- 107
2
votes
2
answers
556
views
Design of a modular application
I'm developing an application (Java) in a modular architecture. I have two approaches in mind and I'm not sure which one will be "better code" in case of maintenance and conventions.
I have ...
- 39
2
votes
3
answers
872
views
How to keep track of Indices
I've discovered my biggest issue with practicing interview questions and writing software more generally is keeping track of indices in python, maybe partly because my first two languages were the 1-...
- 147