The original article was posted by Michael Veksler on Quora

A very well known fact is that code is written once, but it is read many times. This means that a good developer, in any language, writes understandable code. Writing understandable code is not always easy, and takes practice. The difficult part, is that you read what you have just written and it makes perfect sense to you, but a year later you curse the idiot who wrote that code, without realizing it was you.

The best way to learn how to write readable code, is to collaborate with others. Other people will spot badly written code, faster than the author. There are plenty of open source projects, which you can start working on and learn from more experienced programmers.

Readability is a tricky thing, and involves several aspects:

1. Never surprise the reader of your code, even if it will be you a year from now. For example, don’t call a function max() when sometimes it returns the minimum().
2. Be consistent, and use the same conventions throughout your code. Not only the same naming conventions, and the same indentation, but also the same semantics. If, for example, most of your functions return a negative value for failure and a positive for success, then avoid writing functions that return false on failure.
3. Write short functions, so that they fit your screen. I hate strict rules, since there are always exceptions, but from my experience you can almost always write functions short enough to fit your screen. Throughout my carrier I had only a few cases when writing short function was either impossible, or resulted in much worse code.
4. Use descriptive names, unless this is one of those standard names, such as i or it in a loop. Don’t make the name too long, on one hand, but don’t make it cryptic on the other.
5. Define function names by what they do, not by what they are used for or how they are implemented. If you name functions by what they do, then code will be much more readable, and much more reusable.
6. Avoid global state as much as you can. Global variables, and sometimes attributes in an object, are difficult to reason about. It is difficult to understand why such global state changes, when it does, and requires a lot of debugging.
7. As Donald Knuth wrote in one of his papers: “Early optimization is the root of all evil”. Meaning, write for readability first, optimize later.
8. The opposite of the previous rule: if you have an alternative which has similar readability, but lower complexity, use it. Also, if you have a polynomial alternative to your exponential algorithm (when N > 10), you should use that.

Use standard library whenever it makes your code shorter; don’t implement everything yourself. External libraries are more problematic, and are both good and bad. With external libraries, such as boost, you can save a lot of work. You should really learn boost, with the added benefit that the c++ standard gets more and more form boost. The negative with boost is that it changes over time, and code that works today may break tomorrow. Also, if you try to combine a third-party library, which uses a specific version of boost, it may break with your current version of boost. This does not happen often, but it may.

Don’t blindly use C++ standard library without understanding what it does - learn it. You look at std::vector::push_back() documentation at it tells you that its complexity is O(1), amortized. What does that mean? How does it work? What are benefits and what are the costs? Same with std::map, and with std::unordered_map. Knowing the difference between these two maps, you’d know when to use each one of them.

Never call new or delete directly, use std::make_unique and [cost c++]std::make_shared[/code] instead. Try to implement usique_ptr, shared_ptr, weak_ptr yourself, in order to understand what they actually do. People do dumb things with these types, since they don’t understand what these pointers are.

Every time you look at a new class or function, in boost or in std, ask yourself “why is it done this way and not another?”. It will help you understand trade-offs in software development, and will help you use the right tool for your job. Don’t be afraid to peek into the source of boost and the std, and try to understand how it works. It will not be easy, at first, but you will learn a lot.

Know what complexity is, and how to calculate it. Avoid exponential and cubic complexity, unless you know your N is very low, and will always stay low.

Learn data-structures and algorithms, and know them. Many people think that it is simply a wasted time, since all data-structures are implemented in standard libraries, but this is not as simple as that. By understanding data-structures, you’d find it easier to pick the right library. Also, believe it or now, after 25 years since I learned data-structures, I still use this knowledge. Half a year ago I had to implemented a hash table, since I needed fast serialization capability which the available libraries did not provide. Now I am writing some sort of interval-btree, since using std::map, for the same purpose, turned up to be very very slow, and the performance bottleneck of my code.

Notice that you can’t just find interval-btree on Wikipedia, or stack-overflow. The closest thing you can find is Interval tree, but it has some performance drawbacks. So how can you implement an interval-btree, unless you know what a btree is and what an interval-tree is? I strongly suggest, again, that you learn and remember data-structures.

These are the most important things, which will make you a better programmer. The other things will follow.

Many of us who have iPhones download every interesting app we find on the App Store, especially when they’re free. They can range from a simple payment method app, to a game, to a measurement tool. But, as you may have noticed, our phones become cluttered with tons of pages that we have to swipe through to get to an app that we need on demand. However, with an update by Apple that came out not so long ago, you are able to group your applications into categories that are easily accessible, for all of you organization lovers.

To achieve this grouping method, take a hold of one of the applications you want to categorize. Take a game for example. What you want to do is press your finger on that particular application, and hold it there until all of the applications on the screen begin to jiggle. This is where the magic happens. Drag it over to another game application you want to have in the same category, and release. Your applications should now be held in a little container on your screen. However, a step ago, if you did not have another game application on the same screen, and since you can’t swipe, try putting the held game application on any application you choose, and simply remove that extra application from the list, after moving over another gaming application from a different page.

Over time, companies are migrating from COBOL to the latest standard of C# solutions due to reasons such as cumbersome deployment processes, scarcity of trained developers, platform dependencies, increasing maintenance fees. Whether a company wants to migrate to reporting applications, operational infrastructure, or management support systems, shifting from COBOL to C# solutions can be time-consuming and highly risky, expensive, and complicated. However, the following four techniques can help companies reduce the complexity and risk around their modernization efforts. 

All COBOL to C# Solutions are Equal 

It can be daunting for a company to sift through a set of sophisticated services and tools on the market to boost their modernization efforts. Manual modernization solutions often turn into an endless nightmare while the automated ones are saturated with solutions that generate codes that are impossible to maintain and extend once the migration is over. However, your IT department can still work with tools and services and create code that is easier to manage if it wants to capitalize on technologies such as DevOps. 

Narrow the Focus 

Most legacy systems are incompatible with newer systems. For years now, companies have passed legacy systems to one another without considering functional relationships and proper documentation features. However, a detailed analysis of databases and legacy systems can be useful in decision-making and risk mitigation in any modernization effort. It is fairly common for companies to uncover a lot of unused and dead code when they analyze their legacy inventory carefully. Those discoveries, however can help reduce the cost involved in project implementation and the scope of COBOL to C# modernization. Research has revealed that legacy inventory analysis can result in a 40% reduction of modernization risk. Besides making the modernization effort less complex, trimming unused and dead codes and cost reduction, companies can gain a lot more from analyzing these systems. 

Understand Thyself 

For most companies, the legacy system entails an entanglement of intertwined code developed by former employees who long ago left the organization. The developers could apply any standards and left behind little documentation, and this made it extremely risky for a company to migrate from a COBOL to C# solution. In 2013, CIOs teamed up with other IT stakeholders in the insurance industry in the U.S to conduct a study that found that only 18% of COBOL to C# modernization projects complete within the scheduled period. Further research revealed that poor legacy application understanding was the primary reason projects could not end as expected. 

Furthermore, using the accuracy of the legacy system for planning and poor understanding of the breadth of the influence of the company rules and policies within the legacy system are some of the risks associated with migrating from COBOL to C# solutions. The way an organization understands the source environment could also impact the ability to plan and implement a modernization project successfully. However, accurate, in-depth knowledge about the source environment can help reduce the chances of cost overrun since workers understand the internal operations in the migration project. That way, companies can understand how time and scope impact the efforts required to implement a plan successfully. 

Use of Sequential Files 

Companies often use sequential files as an intermediary when migrating from COBOL to C# solution to save data. Alternatively, sequential files can be used for report generation or communication with other programs. However, software mining doesn’t migrate these files to SQL tables; instead, it maintains them on file systems. Companies can use data generated on the COBOL system to continue to communicate with the rest of the system at no risk. Sequential files also facilitate a secure migration path to advanced standards such as MS Excel. 

Modern systems offer companies a range of portfolio analysis that allows for narrowing down their scope of legacy application migration. Organizations may also capitalize on it to shed light on migration rules hidden in the ancient legacy environment. COBOL to C# modernization solution uses an extensible and fully maintainable code base to develop functional equivalent target application. Migration from COBOL solution to C# applications involves language translation, analysis of all artifacts required for modernization, system acceptance testing, and database and data transfer. While it’s optional, companies could need improvements such as coding improvements, SOA integration, clean up, screen redesign, and cloud deployment.

In programming, memory leaks are a common issue, and it occurs when a computer uses memory but does not give it back to the operating system. Experienced programmers have the ability to diagnose a leak based on the symptoms. Some believe every undesired increase in memory usage is a memory leak, but this is not an accurate representation of a leak. Certain leaks only run for a short time and are virtually undetectable.

Memory Leak Consequences

Applications that suffer severe memory leaks will eventually exceed the memory resulting in a severe slowdown or a termination of the application.

How to Protect Code from Memory Leaks?

Preventing memory leaks in the first place is more convenient than trying to locate the leak later. To do this, you can use defensive programming techniques such as smart pointers for C++.  A smart pointer is safer than a raw pointer because it provides augmented behavior that raw pointers do not have. This includes garbage collection and checking for nulls.

If you are going to use a raw pointer, avoid operations that are dangerous for specific contexts. This means pointer arithmetic and pointer copying. Smart pointers use a reference count for the object being referred to. Once the reference count reaches zero, the excess goes into garbage collection. The most commonly used smart pointer is shared_ptr from the TR1 extensions of the C++ standard library.

Static Analysis

The second approach to memory leaks is referred to as static analysis and attempts to detect errors in your source-code. CodeSonar is one of the effective tools for detection. It provides checkers for the Power of Ten coding rules, and it is especially competent at procedural analysis. However, some might find it lagging for bigger code bases.

How to Handle a Memory Leak

For some memory leaks, the only solution is to read through the code to find and correct the error. Another one of the common approaches to C++ is to use RAII, which an acronym for Resource Acquisition Is Initialization. This approach means associating scoped objects using the acquired resources, which automatically releases the resources when the objects are no longer within scope. RAII has the advantage of knowing when objects exist and when they do not. This gives it a distinct advantage over garbage collection. Regardless, RAII is not always recommended because some situations require ordinary pointers to manage raw memory and increase performance. Use it with caution.

The Most Serious Leaks

Urgency of a leak depends on the situation, and where the leak has occurred in the operating system. Additionally, it becomes more urgent if the leak occurs where the memory is limited such as in embedded systems and portable devices.

To protect code from memory leaks, people have to stay vigilant and avoid codes that could result in a leak. Memory leaks continue until someone turns the system off, which makes the memory available again, but the slow process of a leak can eventually prejudice a machine that normally runs correctly.

Related:

The Five Principles of Performance

In Demand IT Skills