Writing pseudocode - Best practices?

Question

I don't want to invite an argument over whether Pseudocode is useful or not here,..there are plenty of questions relating to that. I DO find writing pseudocode useful at times but one thing that crops up all the time is how best do i express it?

Sometimes i end up with a numbered approach, other times I'll use a C style syntax but most of the time it's a mix of what i think is best at the time. That's fine but in 6 months when i come to look over it again it's not always so clear what the intention was! To combat that i've recently started dividing the page into two and down the right half i'll write pidgin [Insert Language Here] and down the left i'll write in really obvious and verbose English.

I don't think there aren't any 'Standards' for writing pseudocode but I'm interested to see how other people do it and maybe that'll help me decide on a unified approach.

Thanks in advance.

Oh, i know this question is subjective and I'm sorry if that's not the intended purpose of SO but it's still a valid question. In fact, are there really that many questions in computing that have a single correct answer? I'll be marking the most helpful answer as correct.

Answer 1

I start by writing in english or mixed with programming language expressions. Then I, step-by-step, replace english with programming language expressions and sometimes leave english words as comments, and then - voila - I have a test function - so it's like pseudo code + TDD all in one approach. I have to mention though, that I don't use this approach always, just when I have to solve a difficult task or design a new not a trivial class.

Answer 2

I like Steve McConnell's chapter on writing pseudocode in his book Code Complete. I know this answer may not be satisfactory if you don't own it but still, if you don't, the book itself is a must have anyway.

Answer 3

I generally avoid any sort of code language altogether and write comments about what I want to happen at any given point in the program. Once the comments are all done, it's a matter of filling in the blanks.

Answer 4

I also find pseudocode useful. Your two-page approach sounds good. You might also look into Literate Programming; I often use an LP style laying out my thoughts as I program, although I don't generally use an LP tool.

Answer 5

I tend to find myself writing small use cases in notepad using indentation... and after half a dozen lines or so I suddenly realise I'm writing in a style which is essentially Python but with a little less syntax! So I've come to the conclusion that Python is actually pseudo code and a fantastic way to prototype your thoughts in whatever language you're really trying to write in. The best thing about this technique is that you already have a reference you can compare your finished result to in the case of nasty bugs.

There are times when a UML sequence diagram is faster than writing as a mental exercise to map out what needs to happen and when, but those two techniques are what I come back to time and time again.

Answer 6

I've never used pseudocode and never felt the need of doing it, I believe that your code can be clean enough if you dedicate some time refactoring it, no matter what language are you using.

I thought I was too lazy, or just against it for some reason but then I found others think the same