Coding style is a set of guidelines that helps readability and understanding of the source code.
6
votes
4answers
424 views
Is this code structure beneficial in any way?
I was recently thrown into a Java web application project, and I’ve come across a number of classes that follow this type of format:
public class MyThingy {
private final int p1;
private final ...
0
votes
0answers
43 views
Is marking members as static against object-orientated programming? [duplicate]
Me and my co-workers are having a bit of a discussion about one of the code analysis issues thrown by visual studio:
CA1822 Mark members as static The 'this' parameter (or 'Me' in Visual Basic) of ...
-2
votes
2answers
122 views
if statements vs logic operators [closed]
When would you use logic operators vs if statements? I am in disagreement with my classmates. They say to just use whatever you are comfortable with. However I disagree due to the fact that if you ...
0
votes
1answer
99 views
Drawing the Line between Coding Style and Algorithm [closed]
Formatting with Indentations, White spaces, and New Lines obviously fit into the coding style category.
if (a == b) {
foo();
}
// vs
if (a == b)
{
foo();
}
On the other hand, something ...
0
votes
4answers
215 views
Where to put try-catch statements [closed]
I have the following code statement that calls a separate class.
if (newOrEdit.Equals("New"))
{
try
{
BusinessLayer.InsertOperator(operatorDetails);
}
catch (Exception)
{
...
53
votes
6answers
3k views
Illusory code duplication
The usual instinct is to remove any code duplication that you see in the code. However, I found myself in a situation where the duplication is illusory.
To describe the situation in more details: I ...
2
votes
3answers
199 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
60 views
Exception to the 'Nested types should not be visible' rule?
Is the following an acceptable breach of the 'Nested types should not be visible' (Microsoft .NET code analysis CA1034) rule?
I have a have a class, let's call it 'TandAOLL', this is tree and an ...
0
votes
2answers
55 views
What's the use of lint warnings vs errors? [closed]
I'm hoping someone who's given this some thought can help me understand. Most style-checking tools seem to distinguish between warnings and errors.
To me, the point of a lint error is that a style ...
2
votes
3answers
159 views
non-optional pointers vs. non-const references in C++
In Other C++ Features, Reference Arguments of the Google C++ Style Guide, I read that non-const references must not be used.
All parameters passed by reference must be labeled const.
It is clear ...
2
votes
1answer
102 views
Type checking as opposed to multiple functions?
In statically-typed languages such as Java, code such as the following is common (not much of a realistic example, I know):
public String flip(String text) {
String result = "";
for (int i = ...
4
votes
2answers
101 views
Rebol refinements vs. dialects vs. objects
I occasionally get conflicted when using a language that isn't Rebol (happens from time to time) and get to thinking, hm—would life be easier in Rebol if this thing worked this way?
To illustrate my ...
3
votes
4answers
143 views
Elegant way to handle multiple pathways based on compound condition [closed]
Consider the following:
if (x == 5 || x == 10 || x == 12) {
if (x == 5) {
doSomething()
} else if (x == 10) {
doSomethingElse()
} else {
doSomeOtherThing()
}
...
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
1answer
145 views
Lines of code that take on too much responsibility [closed]
Intuitively, I know that (in terms of a maintainable, understandable codebase) the following code is bad practice
var foo = fooFunc(barFunc(),wooFunc(chewFunc()));
and might be better stated as
...
1
vote
3answers
353 views
How to design a class for a fixed-length id?
I'm building an app in C# that needs a fixed-length id, which is a string representation of a hex number. E.g. "0fa5" is an example of such an id of length 4. The length would not need to change ...
29
votes
1answer
924 views
What is the term for an anonymous JavaScript function that's called immediately?
I'm writing a JavaScript style-guide for my team, so that we can organise and contribute our documents easier. But I've hit a small bump which is where my question applies...
What am I supposed to ...
0
votes
1answer
56 views
In *nix, is there a practice for storing static libraries?
Lets say you are building an application that staticly links against libraries that you provide it. Where should you store these static libraries? Should you make a directory in the parent directory ...
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 ...
4
votes
3answers
261 views
Creating a Java project without using any objects and just calling static methods on input?
I'm creating a program which takes a document, extracts it, and then moves this into a database. I've done most of this now and I've realised that I haven't made any instances of classes I've made (I ...
1
vote
1answer
259 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 ...
28
votes
5answers
2k views
Should I initialize C structs via parameter, or by return value? [closed]
The company I work at is initializing all of their data structures through an initialize function like so:
//the structure
typedef struct{
int a,b,c;
} Foo;
//the initialize function
...
2
votes
0answers
54 views
Should the order of definitions correspond to the order of declarations in header/source files? [closed]
If my header looks like this:
class foo {
public:
foo();
~foo();
QString b();
QString c();
QString a();
void setB(QString s);
void setC(QString s);
void ...
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 ...
1
vote
1answer
64 views
Best place to declare functions in this example
Suppose I have code that accepts html GET requests:
server.get('path/to/some/endpoint', function(req,res) {
function a() {
//function goes here
}
}
Is it better to declare functions ...
3
votes
1answer
88 views
What is more pythonic - subclassing dict or creating external functions to manipulate them?
Say I have a dictionary that contains complex classes that need to be loaded and unloaded in a special way. (Not especially special, just outside the bounds of this question.) Should I gracefully ...
1
vote
1answer
155 views
Right-aligning code [closed]
I recently was looking for a CSS solution to vertically-align elements, and I found one here.
One thing that I thought was nice was the right-justified code; example:
.vertical-center {
// ... ...
0
votes
3answers
452 views
When to use single-line if statements? [closed]
When reviewing code, I prefer to read if statements that explicitly demonstrate that a fork in code execution may occur:
if ( isFoo(baz) ) {
runBar();
}
When scanning hundreds of lines of the ...
2
votes
4answers
389 views
what is the difference between overengineering, underengineering and rightengineering? [closed]
What is the difference between over-engineering, under-engineering and right-engineering at coding/design perspective?
I found over-engineering: Coding too much like doing future requirement code ...
0
votes
2answers
124 views
guideline on void methods that do not throw exceptions
In our codebase I saw a method that is similar to following:
public void doSomething() {
try {
...
} catch (Exception e) {
...
//log something
...
}
}
...
3
votes
2answers
215 views
Async library guidance
I'm creating a library that contains a class that exposes several Async methods:
public class MyClass {
public async Task<Foo> DoFooAsync() { /*...*/ }
public async Task<Bar> ...
4
votes
4answers
186 views
Using a one-shot class to store not-quite-global variables
I sometimes find myself writing classes (in Python, in my case) that are used like this:
MyClass(some_args).go()
In other words, there's only one method in the class that any external code would ...
1
vote
2answers
131 views
Use of “this” in Golang
On the closest thing Golang has to a style guide found here, under Receiver Names this is written:
The name of a method's receiver should be a reflection of its identity; often a one or two letter ...
-2
votes
2answers
122 views
python code style for long lists [closed]
when coding a very long list in python, is it better to fit several items on each line or should I limit it to 1 per line? 99% of the time I would go with style2 below but I have 5 lists each about ...
0
votes
2answers
241 views
Way to organize repetitive text in Java
Some times I have texts that appears in different places, like comments, messages... For example if I have a custom Exception, probably class doc, messages that passes as parameter to its constructor ...
6
votes
3answers
267 views
Member: Use unique IDs vs domain object
After a couple of useful answers on whether I should use domain object or a unique id as method/function parameter here Identifier vs domain object as a method parameter , I have a similar question ...
0
votes
0answers
36 views
Defensive Programming - “Return” placement [duplicate]
Sometimes I see myself writing code in the following way:
if(value == null) return null;
//... I will have here as many defensive conditions (and returns) as I need
//... Continue to execute method ...
5
votes
2answers
197 views
Is there a name for the anti-pattern of having low-level components controlling higher-level ones?
For example, suppose I had a pageControl UI class and a searcher business logic class with the following :
pageControl.js
function searchButtonClicked() {
// call business logic class method when ...
1
vote
2answers
266 views
Non-printable characters and editors
Today I was presented with a very nasty problem and I do not quite know where to ask this but hope here is ok.
So I have the following string: "\0" (at least that's how it looks in visual studio). If ...
3
votes
4answers
259 views
Function wrappers with no args: bad practice?
My colleague likes to write classes containing methods looking like this:
public function doTaskA()
{
return $this->doTask('A');
}
public function doTaskB()
{
return $this->doTask('B');
...
1
vote
4answers
97 views
Use the company style guide or try to match the incorrect source files? [duplicate]
I'm currently working on a large project in C++. The style guide for this language has been well defined by my company and is available for everyone to see. This particular code-base is being ...
5
votes
2answers
176 views
Identifier vs domain object as a method parameter
Are there any objective arguments for or against using objects vs unique ID as method/function parameters? (and members of other objects?). Specially in the context of statically typed languages ...
0
votes
0answers
91 views
Addicted to Interfaces - Good or bad? [duplicate]
After 2 years of programming, I usually found myself using the following design pattern:
public interface ISomeInterface {
void SomeMethod();
void OtherMethod();
}
public abstract class ...
2
votes
4answers
73 views
If I have a method that needs verification in order to proceed, do I call it inside the method or before? [duplicate]
This has been bothering me. This is more of a pragmatic problem than technical. Imagine I have a SaveOrderChanges method which, as its name implies, will save the order changes when the user submits ...
1
vote
1answer
103 views
When the result set doesn't matter should Left Join or Inner Join be used
When you have a query where you're joining from a non-null foreign key to the foreign table it doesn't matter if you use LEFT JOIN or INNER JOIN from a result standpoint (since there won't be any ...
0
votes
2answers
125 views
Getters with data conversion in Java VOs
I am working on a standard Spring application where DAO layer returns entities to service layer and service layer returns VOs to other services and controllers.
In a certain scenario, we have a VO ...
5
votes
2answers
128 views
What is a reasonable level of detail for a style guide? [closed]
We are developing embedded software for an automotive product in ANSI-C in a large team. Yesterday, in our regular code review, we had a general discussion about the style of our code. We have a ...
1
vote
3answers
212 views
Using prefix/postfix increment operator for simple incremental array access rather than actual index numbers
I cannot decide which method is better with consideration of both readability and fault-tolerance.
Method #1:
Object[] objects = getArrayOfKnownLength();
int i = -1;
someMethod(objects[++i], ...
-2
votes
1answer
97 views
How to name variables without plural in a for-each loop? [closed]
How do you name loop variables when the list item is named after something without a plural? For instance (in python): [x for x in sheep]. x is not a great name, but sheep have/has no plural that ...
0
votes
3answers
254 views
What arguments are there to use a coding style for each distinct language? [duplicate]
I recently had a discussion about our coding style for C# projects. Two things in particular were very hard to agree upon.
Method Naming
C# has the de-facto standard of naming (at least public, ...
