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.

As part of our C++ Tutorials series, here is a free overview of C++ pointers you may enjoy and find beneficial.

C++ Pointers Tutorials

Writing Python in Java syntax is possible with a semi-automatic tool. Programming code translation tools pick up about 75% of dynamically typed language. Conversion of Python to a statically typed language like Java requires some manual translation. The modern Java IDE can be used to infer local variable type definitions for each class attribute and local variable.


Translation of Syntax
Both Python and Java are OO imperative languages with sizable syntax constructs. Python is larger, and more competent for functional programming concepts. Using the source translator tool, parsing of the original Python source language will allow for construction of an Abstract Source Tree (AST), followed by conversion of the AST to Java.

Python will parse itself. This capability is exhibited in the ast module, which includes skeleton classes. The latter can be expanded to parse and source each node of an AST. Extension of the ast.NodeVisitor class enables python syntax constructs to be customized using translate.py and parser.py coding structure.

The Concrete Syntax Tree (CST) for Java is based on visit to the AST. Java string templates can be output at AST nodes with visitor.py code. Comment blocks are not retained by the Python ast Parser. Conversion of Python to multi-line string constructs with the translator reduces time to script.


Scripting Python Type Inference in Java
Programmers using Python source know that the language does not contain type information. The fact that Python is a dynamic type language means object type is determined at run time. Python is also not enforced at compile time, as the source is not specified. Runtime type information of an object can be determined by inspecting the __class__.__name__ attribute.

Python’s inspect module is used for constructing profilers and debugging.
Implementation of def traceit (frame, event, arg) method in Python, and connecting it to the interpreter with sys.settrace (traceit) allows for integration of multiple events during application runtime.

Method call events prompt inspect and indexing of runtime type. Inspection of all method arguments can be conducted. By running the application profiler and exercising the code, captured trace files for each source file can be modified with the translator. Generating method syntax can be done with the translator by search and addition of type information. Results in set or returned variables disseminate the dynamic code in static taxonomy.

The final step in the Python to Java scrip integration is to administer unsupported concepts such as value object creation. There is also the task of porting library client code, for reproduction in Java equivalents. Java API stubs can be created to account for Python APIs. Once converted to Java the final clean-up of the script is far easier.

Related:

 What Are The 10 Most Famous Software Programs Written in Python?

Python, a Zen Poem

Toshiba has released a new line of solid-state drives (SSD) using 19 nanometers, which is currently the industry’s smallest lithography process.

The lineup will include mini-SATA and 2.5-inch form factors along with drives in 7mm and 9.5mm heights. All drives will use the most current serial ATA 6Gbps interface protocol.