Writing maintainable code [closed]

Answer 1

For me writing testable code(checkout Google testing blog) is the better maintainable code

Answer 2

As I see it, the fundamental rule in writing maintainable code is that your code should be very easy to understand. This isn't as easy as it sounds, and you'll have to use all of the other techniques mentioned here to do it. It requires a certain amount of empathy because you'll have to learn how other developers see your code, and how it differs from the way you see it. A good way to get a grasp of that is to go back and look at some code you wrote a couple years ago.

Now, I suppose that it would be possible, theoretically, to write code that is very easy to understand and performs exactly the task it is intended for but which is also hard to modify in any way. I've never seen code like that, though.

Answer 3

It's been a long time, but I have an answer to throw in: don't over comment. This may sound silly, but too many comments explaining simple things can make code messy as all get out. Good comments can work miracles, but pointless ones do quite the opposite.

Answer 4

Write it for other people to read. This means a combination of good names, good comments, and simple statements.

Once upon a time memory was scarce and cycles times were slow. programmers were encouraged to write complex single lines of code that did many things. Today memory is plentiful and cycle times are fast. You should write 5 lines of simple code people can follow instead of one line they cannot understand.

Good comments don't have to be long, but they must be helpful.

Also be consistent. Do not change styles in your code. For example don't change naming styles from one section to the next.

Answer 5

I would say the most important factor is DRY. glenatron Mention it already on his answer among other factors, but I think that's the most important one.

Answer 6

There is no "single most important factor", it is a combination of several factors, as pointed out above.

Now, most of these rules can be condensed into: "write your code to read it later".
Or to paraphrase a funny yet good advice: "Write your code as if it must be maintained by an homicidal maniac knowing where you live."...