Skip to content

Instantly share code, notes, and snippets.

@pogden
pogden / code.md
Last active August 29, 2015 14:26 — forked from Chadtech/code.md

I have been revisiting some of my old code, and naturally, I wonder if I have written good and readable code. I have settled on my own style, that is original. It being original, makes me especially doubtful of it. So I am asking you, is this style any good? And if not, why not?

My style has these two properties:

0 Variable names are as descriptive as possible, making them very long, and often complete sentences of camel case words.

1 Areas of code are seperated by large sections of comments that describe how the code works.

Here is an example: