6.6.5 Coding Style breaches - Breach definition

[abreathingcorpse]

6.6.5 Coding Style breaches - Breach definition

[abreathingcorpse]

While reading a little bit further I got to the 6.6.7 Number of methods / fields / variables section.
It says the following:

[...], this is a breach of the single responsibility principle [...]

Which makes me wonder when you said earlier:

Counting (automatically) the number of coding style breaches [...]

Did you meant that having more than a single Code Style is considered a breach?

[Penaz91]

It seems I created quite a bit of confusion here, my deepest apologies.

At first I thought that you meant something like Python's PEP 8

That is exactly what I meant, but elevated to an "error status" of sorts. You decide on a coding convention and stick to it. This is especially important if your project has a long duration or if you're working with other people. If everyone codes in a different way (stylistically speaking) the resulting code will be harder to read and maintain.

---

[...], this is a breach of the single responsibility principle [...]

The "single responsibility principle" is a coding principle where something (a function or a class, for instance) should do one and only one thing.

Breaching this principle leads to creating "God objects", which are objects that "do everything" as well as other so-called "code smells".

To make a silly example: you wouldn't trust a light fixture that also dispenses water, right? It's doing too many things (it has too many responsibilities) and some of them collide with each other (from a safety perspective in this case). It's way better having a light fixture that lights up your room and a faucet for the water.

---

Did you meant that having more than a single Code Style is considered a breach?

In a way, yes. If the team decides on a coding style, they should stick to it. A "coding style breach" of PEP8 (although a minor one) could be having lines longer than 79 characters.

Reading code is already hard, you're focusing on what the code is doing, if how the code is written changes from one file to another (or even inside the same file!) this will just add one more thing you have to mentally worry about.

---

In conclusion, my usage of "breach" was more geared towards "infringement" than actual security issues.

Hopefully this helps a bit!

[abreathingcorpse]

This makes sense, thanks man.