For the love of God

For the love of all you hold good and dear

Document your code

Reply to this note

Please Login to reply.

Discussion

What does it mean to document your code?

Ouch. 😂

After you are done writing code you do a find and replace for all of your variables, and you change them to random hashes

Some people just want to watch the world burn

I am not one of them. I like to see the world on a perpetual blossom. The better it gets the better it gets. You get what you think.

That’s great. I love it.

What I said was a joke though 😂

Or, at least make the code really self-explanatory. Some of y'all be naming variables a, b, c...

Or just a few comment lines to explain the general idea.

I feel like I have to conjure the spirit of past developers just to understand a few lines of code.

You get something like:

self.config = _config.raw_config

self.config.include = _config.include

And zero explanation for what this “config” is supposed to do.

Working with assembly was easier.

It is a little appreciated fact that the size of the alphabet is a hard limit on the total complexity of a program. The variable z being traditionally used to hold an array of pointers to values that no longer fit in the namespace.

The nice thing about utf-8 is that we can have more than 26 variables by introducing Greek letters.

My code is basically self-documenting. I can go back to it at any point and immediately use chatgpt to explain to me what I was doing. No way to know if it is has the correct explanation but it is AN explanation.

In this economy, I’ll take it. Better than nothing.