Maintain order in the program code

Article#: 00088

Date: 2024-03-05

Author: Radim

Why is it important to maintain order in the program code?

1. Easier readability and understanding:
Code that is well-organized and commented is easier to read for other programmers as well as the author themselves. A simple structure and clear naming of functions and variables facilitate understanding of what the code does.

2. Reduced errors:
When maintaining or adding new features, it's easier to identify and fix errors in well-organized code. Chaotic and inconsistent code makes it easy to overlook mistakes or makes it difficult to fix them without understanding the entire system.

3. Improved efficiency and productivity:
Well-organized code allows programmers to quickly find what they need, reducing the time required to understand existing implementations. This leads to greater efficiency and productivity when working on the project.

4. Facilitates collaboration:
Clean and well-documented code makes collaboration between team members easier. When the code is easy to read and understand, it's simpler to share information and ideas among team members, contributing to the overall development of the project.


How can we maintain order in the program code?

1. Regularly comment code:
Comments are crucial for explaining complex parts of the code or the intent behind certain decisions. Regularly commenting code helps not only others but also yourself when returning to the code after some time.

2. Follow conventions and standards:
Most languages and frameworks have recommended coding conventions and standards. It's important to follow them to ensure your code is consistent and easily readable for other programmers.

3. Divide code into functional blocks:
Dividing code into logical blocks and functions increases modularity and facilitates code reuse. Each function should have a clearly defined purpose and be as short as possible.

4. Use meaningful names:
It's important to name variables, functions, and classes in a way that best reflects their purpose. This improves code readability and understanding.

5. Regularly refactor:
Refactoring is the process of restructuring existing code without changing its external behavior. Regular refactoring helps keep the code clean and reduces the accumulation of technical debt.

Maintaining order in the program code should be a priority for every programmer.

© Radim-Automation, 2020–2025. All rights reserved.
Sharing of this article is permitted with proper attribution (link to the original page).

Related previous articles:

• Keep the documentation up to date throughout the project
• Version control system
• Diagnostic tools
• Documentation issues
• Visual modeling
• Choice of programming language
• Variable names
• Machine modularization
• Abbreviations
• Modular software architecture
• Are there also any disadvantages?
• Think critically!
• Why do automation projects fail?
• Functional and intuitive HMI
• Use a usefull styleguide!
• Write and accept only readable code!
• Who knows it?
• Appoint a representative!
• HMI and PLC applications should grow together
• Prepare a good project plan and keep it up to date!
• Is the way really the goal?
• Do you really want to start with this?
• I can see what you can not see
• More than just start and stop
• Do the right things and do them right!
• Define test scenarios and test cases continuously!
• Everything is difficult until it becomes easy
• Introduce the terminology and standardize it!
• Realize every good idea ASAP!
• Have an expert on hand!
• Communication skills are extremely important
• Don't replace employees in the middle of the project!
• Develop a sense of responsibility!
• Recruit and retain the best employees!
• Don't hide any problem!
• Check the result!
• Keep it simple!
• Development is evolution
• Don't neglect and don't skip any step!
• Transparency and reliability
• From an idea to a consistent system

Related next articles:

• Code formatting
• Make backups, make small changes and test a lot
• Dream of a platform-independent PLC program
• Keep everything you need together
• High Performance HMI
• An irreplaceable employee
• Hidden dangers during commissioning
• The false illusion of rapid progress

Comment#: 00001

Date: 2024-03-06

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#: 00002

Date: 2024-03-25

User: Radim

Remove the "ballast" from the program!

Only include things in the program that are really needed. Unnecessary parts of the code in the program become obsolete, untested, raise unnecessary questions and are a source of ambiguity.

Sometimes it is a good idea to try more than one way in practice to find out which way is the best. However, once we have decided on a particular approach, it is important to consolidate our methods and remove the outdated ones. By removing "ballast" from the program, we eliminate potential sources of confusion and improve the overall quality of the code.

Comment#: 00003

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