Questions tagged [coding-standards]
Coding standards, or coding conventions, are sets of rules or guidelines designed to govern the process of code production in a software project. They're usually based on industry best practices or generally accepted conventions. They include naming conventions, style, prohibited features, and more.
557 questions
0 votes
3 answers
248 views
Is JSON Schema-based runtime validation more practical than static type hints in real-world Python applications?
Question Body I'm currently developing a Python coding standard for use in enterprise-level internal systems. Our typical use cases include: API input/output validation Reading from databases, ...
- 77
2 votes
4 answers
489 views
How to combine multiple functions into a single template based function
Threre are two functions FindMaxDistanceVector and FindMaxDistanceList whose implementation is almost same except some debug information added in FindMaxDistanceList. Note that these two functions are ...
- 133
2 votes
5 answers
746 views
Is Exception caught in the Service class a matter of preference?
In a Java EE legacy project, almost all the DAO and Service classes are written in a a way that DAO level does not catch any exception and instead the service classes catch(Exeption e) in all of their ...
- 1,935
1 vote
3 answers
308 views
Considering IDE and text editor features when choosing a coding style
Recently, I had a debate with one of my friends on using type inference in C# (var keyword). His argument was that we should stick to using the explicit type names because "even with the ...
- 319
0 votes
1 answer
315 views
Creating necessary documentation for maintenance staff when only Code repository contents can be relied on
Conditions: stable legacy prod system no Software Devs of the system are available anymore app is maintained by Engineers, who do not have the same software dev experience like the original Devs and ...
- 125
0 votes
0 answers
59 views
Are type, constant/static/global, and pointer prefixes still necessary in C coding standards, considering the capabilities of modern IDEs? [duplicate]
Our coding standards for C include various prefixes for data types, constants, static/global variables, and pointers. These prefixes were originally introduced for code review purposes, but with the ...
- 127
0 votes
1 answer
88 views
Practical Advice for rapidly changing code maintainability [closed]
This question may get closed quickly, but I'll appreciate any advice I can get and all the resources I can find online about this topic aren't quite relevant to my case. I am a Math PhD student doing ...
- 109
-1 votes
1 answer
217 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