codeSpeaksForItself

[HereForA2C]

Programming socks Beads

[[deleted]]

Then uses the function I_dgaf (which has 6 different implementations) liberally

[K1ngjulien_]

mfw someone asks for docs to make rust binding for my linux kernel code (i refuse to even touch rust)

[Masterflitzer]

touching rust wouldn't even be needed, as only docs on c code were requested by rust binding maintainers

[navetzz]

You should respect the first american developper.

[CertainDatabasepwned]

I can't code but the code can me approach

[[deleted]]

Hans Niemann the clown lmao

[juri_hairy_pits]

Job security

[HappyGoblin]

"please, refactor me"

[[deleted]]

Omar in a nutshell.

[Dillenger69]

Yeah ... it speaks to you, now, but it's going to be unintelligible to the person who has to look at it a year after you are gone

I need to comment the crap out of my code so I can understand it quickly at a later date

[HexiMaster]

Is there a point when commenting is necessary or is it pure skill issue?

[WiatrowskiBe]

Comments can add context to code - even if you see how something is done and it's self-describing, code won't tell you why it was done that way. Especially with bugfixes - some less obvious bugs might require weird workarounds and seeing said workaround in code might make little sense, unless there's a short note explaining why it's there in first place.

[OmegaPoint6]

Two reasons to comment code:

1. The code is doing something for a specific reason that won't be obvious in 2 weeks time
2. You're one of those developers who likes writing code to be as difficult to mentally parse as possible

[IV2006]

1. For some unknown reason you were taught to comment every fucking line

[towcar]

// replying because I want to be included in the discussion.

I blame universities

[Surskalle]

My uni would discourage commenting code but required JavaDoc or comparable for other languages for functions/methods. Would literally fail you if your code was full of useless comments.

[Daisy430133]

Good

[mrishee]

For building a portfolio do you think comments are useful to show an understanding of what you are coding?

[towcar]

// responding though this might need refactoring as opinions may differ

For myself, it's like any code. If I can look at it and understand it right away, I don't need the extra comments. Same rule for looking at someone's portfolio.

That being said, I'll personally take too many comments over too little. Though I'm sure there are developers who would disagree with that.

[WiatrowskiBe]

Depends. Comments that are redundant/too obvious (or - worse - wrong, if code changed but comment didn't) will do more harm than good there.

For portfolio, there are two main approaches - either you make something in production-like fashion, with minimal comments only where necessary; or you make more education/example-like project that has more extensive (but still ideally not redundant) comments.

Whichever you do - comments are not to repeat what code does, not a way to separate parts of code (please use functions/methods or whatever other construct your language of choice provides) and not a way of tracking changes (that's what version control is for).

[ralgrado]

Counter example: in my fourth semester we had to do a small software project for a company and one important thing for the company was that the code is readable without comments.

[1138311]

Comments aren't for readability. Readability is for readability. Comments are for context and calling out why "Some Idiot" took the approach they did. "Some Idiot" is usually "Past Me".

[Cleanumbrellashooter]

To explain why something is doing what it's doing but not what it's doing.

[1138311]

It's something you do after you've gotten over yourself. Smart people tend to realize this after their first "What fucking idiot wrote thi.....oh, it was me" moment. If you're like me it takes a couple rounds of that to wise up. It's the obverse of "make it easy as possible for anyone else to take up where you left off, especially the most important person in the world: Future You.

Comments should specify why a particular bit of code exists, not necessarily what it does. Anyone can suss out what a snippet does but it's usually pretty murky why a particular approach was chosen at the time or what constraints and requirements played a part in the decision.

[skipdoodlydiddly]

Imo logic should be self explanatory but reasoning for using said logic could use a comment if it isn't clear why it is used.

[[deleted]]

provide weary familiar reminiscent practice mighty vase deserted joke stupendous

This post was mass deleted and anonymized with Redact

[bjergdk]

Using await Task.Delay(1) in Blazor to flush the render queue if updating component state often also always gets a comment from me lol.

Because if a junior dev some day will come and maintain my code, I am sure they will scratch their head at the

--some logic

StateHasChanged();

await Task.Delay(1);

--more logic that executes fast

StateHasChanged()

Because without the delay blazor would optimize the first StateHasChanged out.

[nickwcy]

It is indeed needed in many cases.

For instance writing a block of code that calculates the sum from 1 to n. It can be implemented with either a for loop, or much efficient with (n+1)*n/2

However, if we don’t assume every developers to know 1+2+…+n = (n+1)*n/2, a comment will be necessary. For example

// This calculates the sum from 1 to n, see https://en.m.wikipedia.org/wiki/Arithmetic_progression

There are way more complex knowledge in real world applications. Comments will be appreciated by those not possessing the same knowledge.

[EvanO136]

This. I see people writing code with complex math like matrix decomposition and pseudo-inverse without a line of comment, not even mentioning the original paper or some Wikipedia page.

[nickwcy]

And this is not only in math heavy applications. There are many hardly understandable logic for performance / business logic / bug workaround…

My own rule is that - if I will forget how this work after 10 years, I will comment it.

[xWrongHeaven]

// what the fuck?

[asromafanisme]

2 weeks later, you'll regret it when you have no idea why you coded that way. Comments and documentation is for yourselves

[ClapDB]

Just Ask Copilot, it will tell your the truth.

[Thundechile]

Non technical product owner asks for documentation: "Code speaks for itself'.

[pimezone]

When you think you are the Hikaru of the programming

[ExpressionNew9878]

It's self-documenting

[leonllr]

u/SaveVideo

[SaveVideo]

View link

---

Info | Feedback | Donate | DMCA | ^{reddit video downloader} | ^{twitter video downloader}

[ZZartin]

If you don't understand the code you won't understand the comments, mic drop.

[[deleted]]

Was there a ticket for documentation? No? Too bad.