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.

Since its foundation, HSG has been a leader in Business Rule Management Systems Training and Consulting services by way of the Blaze Advisor Rule Engine.  Over the years we have provided such services to many of the worlds largest corporations and government institutions whose respective backgrounds include credit card processing, banking, insurance, health and medicine and more, much more.  Such training and consulting services have included:

Create a wrapper object model in either Java, .NET or XML

Identify and catalog business rules

Develop a rule architecture within Blaze Advisor that isolates rule repositories as they relate to functionality and corporate policies

Configure, develop and implement a variety of interfaces to the rule engine from disparate systems ranging from mainframe applications written in Cobol to UNIX/Windows applications using Enterprise Java Beans, Windows Services, Web Services, Fat Clients, Java Messaging Services and Web Applications.

Review and update code to boost efficiency either by way of

    Removing functions calls within conditional statements

    Ensuring that database calls are essential or can be rearchitected in some other manner

    Employing the rete algorithm where necessary

    Paring down extensively large class models

    Deploying such appliations in multi-threaded systems

·         ...

Call us if you:

    are in need of Blaze Advisor Expertise
    are developing SMEs in Blaze
    want to speak directly with an expert (no placement agencies)
    want an affordable alternative to FICO
    want to work with an industry leader

Checking to see if a file exists is a two step process in Python. Simply import the module shown below and invoke the isfile function:

import os.path
os.path.isfile(fname)

There are many excellent opportunities for IT professionals to present themselves to corporate entities for future consulting positions. You can find yourself in your next consulting engagement if you are willing to combine your IT skill-set, a good amount of corporate research and a bit of old fashioned moxie. Contrary to popular practice for applying for jobs through placement agencies and recruiters, it’s possible to meet with hiring managers, representing your firm, you, directly.

Although recruiters may not take a fee directly from you, the fact that they charge a fee for their services to a company after your placement may keep them from being able to place you. On the other hand, corporations searching for individuals with advanced knowledge of IT functions cannot rely on the friends and family of current employees to find superior consults in all fields.

What are some other options? First take the time to research corporations you would like to consult with. Look for the ones that most likely are complementary to your area of expertise because of the goods they produce or the services they provide to the public. Or you may opt to choose a company that is geographically close to where you live for the convenience of a short daily commute.  

Another way to find your next consulting job is to actively scan the news and see what corporations are making waves within their individual marketplaces. This is a good indicator of possible expansion and the need to hire on a contractual basis. Another good indicator of a need for IT professionals is a mention of a company relocation or expansion. Growth or renovation of office environments is often accompanied by a modernization of IT systems. Current IT team members may not be relocating or might not be familiar with systems other than the ones they already service.

Do as much research as possible about each corporation from their own websites and other sources dedicated to their particular field of endeavor. This gives you the edge in being able to speak about the IT systems they already have in place or your ideas for adapting their line of work or new product with the use of an IT system advancement. Their websites will often have a list of their corporate management. Make sure you address your cover-letter and resume to not only the Director of Human Resources, but to all executives in charge of their IT departments. Be specific in your abilities and the fact that you can be flexible with hiring arrangements.

Attend job fairs that have an emphasis on the more technical fields. When possible, also circulate your resume both digitally and in paper format to smaller and mid-sized companies. These corporations may not be able to maintain their own full-time IT group for fiscal reasons and your consulting prowess may be able to “save the day” for them in an emergency. You can become part of a corporate team on your own; all it takes is additional work on your part. However after your consultant job placement, you will be pleased that your efforts have succeeded so well.