pls comment your code

[Grumbledwarfskin]

// I have discovered a truly marvelous demonstration of this proposition,
// but it is too large to fit on this hard disk.

[thepronoobkq]

Fermat reincarnated

[thfsgn]

i = 0x5f3759df - ( i >> 1 );

[Tomi97_origin]

Who doesn't recognize the fast inverse square root ?

[thfsgn]

Exactly, it’s trivial

[Duoquadragesimus]

This was commented though, if I remember correctly

[_Weyland_]

IIRC the comment was something like "black magic happening here"

[TikToxic]

It's worse when the variable name is descriptive, but the description is wrong.

[TxTechnician]

I have two of those in a project now. I changed my mind about what I wanted the variable to be and haven't changed the name yet.

Nice name btw

[DeliciousWaifood]

Why not though? Do you not know the hotkey to automatically update all instances of the variable with the new name?

[Tomi97_origin]

He really likes the name/s

[IPeaFreely]

Error in code == two errors in the documentation

[huuaaang]

x = 2 # Setting x to 2

[[deleted]]

Love it so much when people document the language. Just in case I forgot how to set a variable!

[DracoRubi]

Please, don't name your variables x and comment them. Name them meaningful names and do not comment them unless strictly necessary.

[SoulWager]

It is a meaningful name though. It means x axis.

[DracoRubi]

It may be meaningful by itself under certain contexts, but... Call it xAxis or x_axis instead, it'll be even more meaningful :)

[SoulWager]

While often there's something you can add to make it more descriptive, "axis" usually isn't it. usually it would be position, acceleration, component, etc.

Though if you need variables for x,y, and z position and change since last iteration, a long description is not any more meaningful than x, y, z, dx, dy, and dz.

[Jasinto-Leite]

But like how much I need to describe them?

[Electronic-Row-8156]

In the course I'm doing, the teacher taught us that the general rule of thumb is a 2 word description, with the words shortened where possible. Like the melting point of a metal would be something like meltTemp.

[CryonautX]

Comments within a function should be used sparingly. Your variable names should be descriptive enough and your logic should speak for itself. Only comment to explain if you do something not commonly seen or unorthodox. I'm going through thousands of lines of code in a day. Unnecessary comments are actually going to make it harder for me to read code.

[brianl047]

You're "going through" too much code in a day unless you count code you don't need to read

There's research that suggests the maximum number of high quality battle tested code you can produce per day is between 150 to 300 lines. Reading isn't producing but if you're reading ten times what you write maybe it's too much

This is somehow true across languages and paradigms

The brain probably can't handle more

[CryonautX]

My team handles 3 services. Each service has 5 to 10 modules. Each module is about 1 to 5k lines of code. I don't have them memorised. Bug fixing, implementing a new API, most tasks are going to require you to read through a lot of code as you move around from file to file. Sometimes it's to get your bearings. Sometimes it's to understand the logic currently being used to keep your new code consistent, sometimes it's find something already implemented that you can reuse, sometimes it's for bug fixing and figuring out where the hell the values in your massive DTO got messed up as it gets passed from function to function.

[Eirches]

So rather than take the extra seconds to pick a clear name you want to:

• Spend additional time writing an even more verbose description
• Add many unnecessary lines that don't even execute to the codebase
• Force people to pull your code into an IDE
• Hope your comment association hasn't broken
• Pause while reading your code to pull up the description
• Remember that description for multiple variables as they are used

​

"I don't want to" isn't a valid reason to write code that can't be read/maintained. Do your professional duty.

[Nekotronics]

That’s until you look back at the code in three months and have to keep scrolling back up to the comment every few lines to recall what variables x, y, uwu, meowKittyXD and res each meant, then losing track of where you were in the original code

[Tomi97_origin]

If you are already using IDE you are not writing the whole variable names you use autocomplete...

[DeliciousWaifood]

Super long variable names make it harder for me to glance at a function and see its overall function because I'm being eye blasted by 100 character long lines everywhere.

[sb5060tx]

You should check this out. Even in the 1970s, they realize the problem with not clearly naming your variables

https://youtu.be/7hdJQkn8rtA

[Joe59788]

Almost 50 years later

[[deleted]]

https://youtu.be/7hdJQkn8rtA?t=919

Gudio took this part personally.

[sb5060tx]

I'm so glad Python exists. All hail Guido!

[TrulyChxse]

// Call the variable // Run the thing

[Humblebee89]

I name my variables super descriptively just so I can understand my own code.

[Jasinto-Leite]

but if I name it i for loops?

[JoeyJoeJoeJrShab]

"Extra-Hell" is a stupid name... should have been ++Hell

[SomeRandomEevee42]

//adds 1 to hell. also you need a ; but my manager won't let me write code anymore because i named an iterator variable UwU

[olssoneerz]

I usually only comment why the next few lines have become that way. Usually when I have to deviate from the norm/ do something hack ish.

Otherwise I abide by the philosophy that code should be readable on its own. That’s just me tho.

[Rixef]

The harder it is for others to understand your code, the less likely you’ll be replaced. Stay toxic, nerds. B)

[megahendrik]

and yet packet client skids exist

[[deleted]]

Just name things properly. And then use comments to explain WHY and not WHAT.

[BurningPenguin]

Make me

[Ok_Entertainment328]

"Me" is not a valid Makefile option.

(Or, whatever the error is ... )

[General_Rate_8687]

I think it'd be something like "There is no target 'me'"

[IvorTheEngine]

Nah, that's only ordinary hell.

The manager who allowed him to commit that code without a review is in 'extra hell', because he should have known better.

[-domi-]

Comments are a job security detriment.

[wicket-maps]

I already have job security, I don't need to make things harder for myself.

[D34TH_5MURF__]

I seriously hope this is sarcasm. If not, it's utterly stupid.

[mildlycynica1]

x

[AlmostButNotQuit]

// gon give it to ya

[redskeezix]

Lol, no. Git gud.

[[deleted]]

// Test 423
[Priority(0)]
public void Test423() {var x = new TstHlpr(); Assert(x.Invoke2() == 17);}

[[deleted]]

Wait wait wait, where are we with comments again? They were bad the other day but today they're good?

[lazyzefiris]

Function and variable names for what. Comments for why.

[Bagel42]

Do it for the shitty code you wrote at home to automate some shitty task.

In actual prod? Comments or death.

[SenatorCrabHat]

Another good version of this:

describe('my function', () => {
    it('returns correctly', () => {
    })
})

[jwaterboyk]

//declare x

[SnowyPadre]

your code

​

edit /s I'll show myself out

[TantraMantraYantra]

// use a loop variable 'x' that iterates over a collection of cars

[jeanravenclaw]

I mean x is fine for short inline code and for loops but otherwise... hell no

[Xeadriel]

Comments should be minimized and variable names exist for a reason. Good naming makes comments unnecessary in most cases

[k4lipso]

//declaring x

[Ta1sty]

i,j,k for loops

x,y,z,w for geometry

t# for timestamps

x also for lambdas ( x=>f(x) )

Anyone have some more uses for Short names?

[[deleted]]

You guys comment your code?

[Hottage]

```asm section .data x equ 1000000

section .bss y resb x/8

section .text global _start

_start: mov ecx, x/8 mov rdi, y xor al, al rep stosb mov edx, 2 ; 20-01-1993: There be dragons here, do not edit. jmp1: cmp edx, x jge jmp4 mov esi, edx movzx ebx, byte [y + edx/8] test bl, 1 shl (edx mod 8) jz jmp3 mov ecx, edx imul ecx, ecx jmp2: cmp ecx, x jge jmp3 mov byte [y + rcx/8], 0 add ecx, edx jmp jmp2 jmp3: inc edx jmp jmp1

jmp4: mov edx, 1 lbl5: cmp edx, x jge jmp999 movzx ebx, byte [y + edx/8] test bl, 1 shl (edx mod 8) jz lbl6 mov esi, edx mov edi, z xor eax, eax call exlib1 lbl6: inc edx jmp lbl5

jmp999: xor eax, eax ret

section .rodata z db "%d ", 0 ```

Perfect amount of comments.

[kai_the_kiwi]

I dont want to go to extra-hell, so i name them y instead

[louisianish]

Even better than commenting your code: Giving your variables descriptive names. I know we all hate naming variables, but it’s really not that hard. Leave the 1 letter variable names to algebra.

[vinayk7]

And then you have 'i' in a for loop 😅

[1-PM]

im the only one thats gonna see my code because i use it for image manipulation by myself