Abbreviations
Article#: 00069
Date: 2021-09-30
Author: Radim
In every document in which we use abbreviations, we must also explain these abbreviations.
It is advisable to create a table with alphabetically sorted abbreviations and their meanings right at the beginning of the document.
Every abbreviation used in the program must also be explained!
Using abbreviations can make writing code shorter, easier, and faster.
However, it makes the code difficult to read and understand.
It is usually better to avoid using abbreviations.
However, this is sometimes not possible because some program objects (libraries, function blocks, structures ...) or variable names have a limited maximum length.
Abbreviations can be a tough nut to crack for new team members.
The best practice is to write all abbreviations with their full meaning in alphabetical order in a text file that we attach directly to the project.
Every new abbreviation used in the program must also be written to this file.
When someone comes across an abbreviation in the program that they don't understand, they can find its meaning in the file. :-)
© Radim-Automation, 2020–2025. All rights reserved.
Sharing of this article is permitted with proper attribution (link to the original page).
Related previous articles:
- Think critically!
- Learn from your journey!
- Why do automation projects fail?
- Use a usefull styleguide!
- Write and accept only readable code!
- Write down your best practices and processes!
- I can see what you can not see
- More than just start and stop
- Do the right things and do them right!
- Introduce the terminology and standardize it!
- Realize every good idea ASAP!
- Communication skills are extremely important
- Think on paper!
- Sharpen your axe before you start felling!
- Check the result!
- Keep it simple!
- Choose the right tool!
- Development is evolution
- Don't neglect and don't skip any step!
- Transparency and reliability
Related next articles:
- Variable names
- Choice of programming language
- Documentation issues
- PLC network diagram
- Keep the documentation up to date throughout the project
- Maintain order in the program code
- Code formatting
- An irreplaceable employee
- The false illusion of rapid progress
- What makes an HMI intuitive?
Comment#: 00001
Date: 2022-11-30
User: Radim
If we need to choose an abbreviation for the name of a variable or any other element in the program, it is advisable to choose such a combination of letters that will indicate its full meaning, and it is also advisable to choose such a combination of letters that when we do that Search the program for occurrences of this abbreviation, it returns nothing but all occurrences of this abbreviation. This means that the abbreviation should not appear in any word used in the program, so a global search for that abbreviation throughout the program is helpful.
Comment#: 00002
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#: 00003
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.