Use a usefull styleguide!
Article#: 00056
Date: 2021-03-11
Author: Radim
The code must be easy to read for those who read it and also easy to write for those who write it.
A style guide helps the team write the code uniformly.
New team members do not have to search for the way how to write the code if the rules are given in the style guide.
The style guide enables more people to work on a project in a team, to familiarize themselves with foreign code and to complement one another.
Ideally, the code looks like it was written by one person, because then everyone on the team will be familiar with it.
Each team should create and write down their own appropriate rules for writing the code.
Since a written description will never contain everything, developers should also pay attention to the way of writing and standardize it with each other, when reading a foreign code.
If there are generally accepted conventions for a programming language or development environment, base your own rules on those conventions.
The rules must be simple enough that team members don't have to think about them.
Once the set of rules is too complex, it no longer offers any practical advantages.
© Radim-Automation, 2020–2026. All rights reserved.
Sharing of this article is permitted with proper attribution (link to the original page).
Related previous articles:
- Write and accept only readable code!
- Who knows it?
- Appoint a representative!
- Write down your best practices and processes!
- HMI and PLC applications should grow together
- Do you really want to start with this?
- I can see what you can not see
- Do the right things and do them right!
- Don't make it worse!
- Write a project diary!
- Keep the answers to the question "Why"
- Everything is difficult until it becomes easy
- Introduce the terminology and standardize it!
- Realize every good idea ASAP!
- Ask questions!
- Communication skills are extremely important
- Don't replace employees in the middle of the project!
- Develop a sense of responsibility!
- Get the things done with a small, motivated team!
- Focus on target!
- 9 women can't make a baby in a month
- Sharpen your axe before you start felling!
- Understand - Agree - Be Identified - Believe
- Don't hide any problem!
- Check the result!
- Keep it simple!
- Don't leave a work package half-finished!
- Development is evolution
- Don't neglect and don't skip any step!
- Transparency and reliability
Related next articles:
- Functional and intuitive HMI
- Learn from your journey!
- Modular software architecture
- Abbreviations
- Machine modularization
- Knowledge gained from a completed project is priceless
- Variable names
- Choice of programming language
- Documentation issues
- Clear signals
- My boss was a hero
- Version control system
- Keep the documentation up to date throughout the project
- Maintain order in the program code
- Code formatting
- Graphic designer
- Dream of a platform-independent PLC program
- Keep everything you need together
- An irreplaceable employee
- HMI - Don't overdo it with complex design
- The false illusion of rapid progress
- HMI - light versus dark design
Comment#: 00001
Date: 2023-04-11
User: Radim
IEC 61131-3: Coding Guidelines
- See more on: https://stefanhenneken.net/2016/04/08/iec-61131-3-coding-guidelines-2/#more-704
Comment#: 00003
Date: 2024-02-22
User: Radim
Is your native language not English and do you work in an international team? Have you agreed on English as the project language within the team? Then please:
1. Install and use all project tools in English.
2. Use English help files for the tools.
3. Write English variable names and comments in the code.
These rules make collaboration between team members, documentation and support tasks easier. Because people will use the same terms.
Do you agree with these rules?
Would you add anything else?
Comment#: 00004
Date: 2024-03-25
User: Radim
There are some advantages of alphabetically sorting variables within a declaration block:
1. Easier searching: When variables are sorted alphabetically, it is easier to find a specific variable because you know it will be located at a certain place in alphabetical order.
2. Faster updates and modifications: When updating or modifying existing variables, it is easier to find the relevant variable if variables are sorted alphabetically.
3. Simpler creation of new variables: When creating new variables, you can more easily choose a suitable name if you have an overview of all existing variables and their alphabetical order.
4. Code clarity and maintenance: Alphabetically sorting variables contributes to the clarity of the code and facilitates its maintenance because the programmer knows where to look for a specific variable.
However, it is important to adhere to consistent rules for naming variables.
Comment#: 00005
Date: 2024-04-10
User: Radim
"Code conventions are important to programmers for a number of reasons:
• 40%–80% of the lifetime cost of a piece of software goes to maintenance.
• Hardly any software is maintained for its whole life by the original author.
• Code conventions improve the readability of the software, allowing engineers to understand new code more quickly and thoroughly.
• If you ship your source code as a product, you need to make sure it is as well packaged and clean as any other product you create."
- https://en.wikipedia.org/wiki/Coding_conventions