Introduction

This document provides the coding style for the PLC code that makes up the core of PLC Framework.

Why a ‘coding style’?

If you have noticed, there is no single style for programming PLCs, and the problem is fundamentally that each provider names their elements as they see fit. Additionally, the first PLC programmers were not high-level code programmers (C, C++, Java, Python, etc.) but mostly electrical or electronic engineers, so each one programmed as best they could.

What do I mean? Each programmer, team, company has their way of naming variables, constants, data types, functions, etc. There is no clear separation between function, subroutine, and not to mention the incorrect use of the term macro.

This situation does not happen with other developers, such as backend, frontend, they work with frameworks and clear and specific code style guides.

How would you name the variable 'is running'?

IS_RUNNING
is_running
Is_running
Is_Running
isRunning
IsRunning
is-running
Is Running 😱😱😱
isRng
Is_rng

How would you name the constant 'status done'?

status_done
Status_Done
STATUS_DONE
statusDone
STATUS-DONE
statusDone

And so, until exhausting all possibilities, all logical, all lawful, and yet without clear rules 😔.

For us, coding style is as important as the code itself. That is why the first chapters of the documentation will be dedicated to coding style.

Before we start

The coding style of our framework is based on the following styles:

🐫 Camel Case The Camel Case style is used to name variables, functions, and other elements in such a way that each word within the name starts with an uppercase letter, without spaces or hyphens. For example: "MyExampleVariable". This style improves readability by highlighting each word within the name, making it easier to understand and use in the code. There are two variants: Lower Camel Case and Upper Camel Case (Pascal Case).

🐍 Snake Case The Snake Case style is used to name constants, functions, and other elements in such a way that each word within the name is separated by underscores (_). For example: "my_example_variable". This style improves readability by clearly separating each word within the name, making it easier to understand and use in the code. There are two variants: Lower Snake Case and Upper Snake Case (Screaming Snake Case).

🍢 Kebab Case The Kebab Case style is used to name elements in such a way that each word within the name is separated by hyphens (-). For example: "my-example-variable". This style improves readability by clearly separating each word within the name, making it easier to understand and use in the code. It is commonly used in file names and URLs.

Let’s get started! 🏁