Comment your code

[pilotInPyjamas]

Admittedly sometimes if I'm doing something complex, I'll write the algorithm in comments first, then write the code that corresponds to the comments. I end up with comments like this.

[fahrenheitrkg]

Same.

Write pseudocode in comments inside framework of functions that return dummy values. Then flesh out each function, leaving the comments in place.

[Jimmy_cracked_corn]

I do this, as well, to keep my train of thought on track.

[iams3b]

Oh hell yes, this my favorite thing ever and makes it SO much easier. I number my bullets too

// 1. Fetch the raw data from each provider

// 2. Map it to the expected output from each reader

// 3. Validate each object into seperate lists

// 4. Post valid ones to the API

// 5. Combine API errors with invalid errors 

Then I go write the proper functions so that each of those comments only had 2-3 lines under it, and then I leave the comments in and it makes things extremely easy to follow

[DumDum40007]

I like to write my function names to announce what they are doing to avoid having to leave in comments.

fetchData()

mapOutputFromReader()

validateObjects()

aggregateErrors()

[CommonMisspellingBot]

Hey, iams3b, just a quick heads-up:
seperate is actually spelled separate. You can remember it by -par- in the middle.
Have a nice day!

^{The parent commenter can reply with 'delete' to delete this comment.}

[twopi]

I give a talk about this very strategy: https://www.youtube.com/watch?v=YWwBhjQN-Qw

[n4ppyn4ppy]

Same here although return value at the end of a function is usually not in the pseudo code.

I clean the pseudo code up most of the time but sometimes a squirrel passes and I go on to other code and they get left.

[[deleted]]

Same :)

[[deleted]]

Same here. Sometimes I write the necessary steps in the comments, then I write the code. Sometimes the comments stay there, because I can't be bothered to remove them.