There have been multiple accounts created with the sole purpose of posting advertisement posts or replies containing unsolicited advertising.

Accounts which solely post advertisements, or persistently post them may be terminated.

programmer_humor

This magazine is from a federated server and may be incomplete. Browse more on the original instance.

lando55 , in Shit Happens

Troubleshooting checklist:

  1. DNS
  2. Fuck if I know
BabaYaga ,

It’s always DNS

theolodger ,

A haiku about DNS

It’s not DNS There’s no way it’s DNS It was DNS

Potatos_are_not_friends ,

Restarting a server or booting a new instance has been my solution for years.

Technoguyfication ,
@Technoguyfication@lemmy.ml avatar

Or as I’ve discovered recently while troubleshooting local infrastructure, the ARP table. Essentially the DNS of IP addressing

bleistift2 , in Shit Happens

“Don’t these guys have a test suite⁈”

andrew ,
@andrew@lemmy.stuart.fun avatar

It’s me. Hi. I’m the problem, it’s me.

bleistift2 ,
President_Pyrus ,
@President_Pyrus@feddit.dk avatar

Is that a fancy word for prod?

Xylight , in Shit Happens
@Xylight@lemmy.xylight.dev avatar

Honestly I get more angry when it’s my own site because then I have to fix it :P

MCForTheBest ,

On the contrary I get less angry when it’s my own site because I usually have at least some idea of what could have gone wrong

Boinketh ,

It depends on how badly you need to use the site. If you need it and it’s your site, it’s a lot better because you can fix it. If you don’t need it, you still have to fix it if it’s yours, but you can just walk away if it isn’t.

NotAnonymousAtAll , in Always write comments

About comments:

Please please please, do not always write comments. Try to write code that does not need comments whenever possible. Proper variable, class and method names go a long way. If you think a block of code needs a comment, turn it into a method and give it a proper name instead.

Comments should be a last resort for cases where making the code self explanatory is not possible, and those should be rare.

About optimization:

Optimal code is code that fulfills it’s purpose without observable issues.

If you try to make something faster without any prior complaints or measurements indicating that it being slow is an actual issue, you are not optimizing, you are just engaging in mental masturbation.

JDubbleu ,

For my current job we’ve all agreed to take the approach of not writing comments that say what the code does, but why you did something the way you did. Probably about 90% of our code is uncommented because it just doesn’t need to be, but every once in a while you have to do something out of the ordinary to get the desired behavior, and explaining why you made the weird decision you did is infinitely more helpful.

dukk ,

This exactly. I love this approach to commenting and use it all the time. I also like to write doc-comments wherever possible; it’s saves time and makes working on an unfamiliar part of the codebase much easier.

sweeny ,

I just get AI to write my comments lol. I’ll paste the function or component and tell it to write comments in tsdocs format and it works great every time (I will also add to it sometimes of course).

Don’t get me wrong, I also write clean code with good function and variable naming, but I find comments are also useful for a few reasons; they make the code even more quickly readable, they can explain why the code is the way that it is, and my favorite reason, they make it so when you hover over a reference to the commented item in an ide you get an explanation of exactly what the code does and what it expects without having to find and read the code itself

blackbirdbiryani ,

The problem here is that every junior programmer thinks they write clean code when they really really don’t. Often I find the act of writing comments makes you go back to the code and clean things up, so it’s still worth encouraging comments.

Von_Broheim ,

Just do TDD instead

squaresinger ,

I strongly disagree with the comments. “The code is the documentation” was a dumb joke about being to lazy to write documentation, not a best practices guideline.

Proper naming is good, but there are a lot of issues with not commenting code. Obviously it’s dumb to comment every line, but it’s really useful to comment functions/methods, because otherwise you never know if something’s a bug or a non-obvious feature. Comments act as a parity check to the code, since they tell you what the dev who wrote the code wanted the code to do.

Also, everone thinks they write good, clean and obvious code. Hardly anyone purpously writes bad, hacky code. Yet if you look at code you wrote a year ago, or code someone else on your team wrote, it’s full of non-obvious hacks. That means, people constantly misjudge the obviousnes of their code. Comments should be put on anything that could maybe be non-obvious.

And putting documentation of the code anywhere else than in a comment (e.g. Confluence) is a total waste of time (unless you put a link to the specific page of the documentation in a comment in the code), because documentation that you don’t directly see without effort will not be found and not be read.

NotAnonymousAtAll ,

it’s really useful to comment functions/methods, because otherwise you never know if something’s a bug or a non-obvious feature. Comments act as a parity check to the code, since they tell you what the dev who wrote the code wanted the code to do.

Unit tests should be the parity check for other code. Those don’t get outdated with the next refactoring where someone didn’t remember to also adjust all the comments.

Also, everone thinks they write good, clean and obvious code. Hardly anyone purpously writes bad, hacky code. Yet if you look at code you wrote a year ago, or code someone else on your team wrote, it’s full of non-obvious hacks. That means, people constantly misjudge the obviousnes of their code. Comments should be put on anything that could maybe be non-obvious.

Why would people be better at judging if something needs a comment than at judging if something needs a better name or refactoring? Asking people to skip that judgement step and comment everything just gives you a bunch of useless boilerplate comments. That trains everyone reading that codebase to ignore comments because they are almost always useless anyway.

putting documentation of the code anywhere else than in a comment (e.g. Confluence) is a total waste of time

At least this we can 100 % agree on. Documentation should be as close as possible to the code. (I just think most of the time that place is in the name of things, not in an actual comment.)

squaresinger , (edited )

You can’t be too obvious when writing code. Good names, good code structure, unit tests and comments are not mutually exclusive. And comments are the cheapest part of all of that. Commenting what a method does takes a fraction of the time that good code structure or unit tests take, so adding a comment is rarely not worth the effort.

Why would people be better at judging if something needs a comment than at judging if something needs a better name or refactoring? Asking people to skip that judgement step and comment everything just gives you a bunch of useless boilerplate comments. That trains everyone reading that codebase to ignore comments because they are almost always useless anyway.

Again, who is asking them to skip judgement? I am saying, do comments additionally.

And forcing programmers to do anything they don’t understand or are against will always result in useless results. I’ve seen enough unit tests that don’t actually test what the tested code does. I’ve seen nonsense comments. I’ve seen naming that “follows” the guideline but is totally useless or even wrong. I have even seen code that was implemented in spite and where the code superficially checks all the boxes but is totally terrible once you peek beyond that. Same goes for the whole process. If a programmer doesn’t care for code reviews, you get nothing by forcing the programmer to do them.

Does this mean all of these things are useless, just because programmers can purpously sabotage them and find loopholes that fit the guidelines? I don’t think so.

At least this we can 100 % agree on. Documentation should be as close as possible to the code. (I just think most of the time that place is in the name of things, not in an actual comment.)

If you can fit all the information about what something does plus all the specifics, edge cases, non-obvious things and the reason why this specific approach was taken in maximum 4 words, then yes. Otherwise comments are the way to go.

Having no documentation is fine for a small project with one dev that will get tossed in a year. But if you are making something that will actually be used for longer, than it’s not ok.

Von_Broheim ,

If you’re writing an explanation of what your code does then, ding ding, you’re writing code. If your code has so many side effects and garbage in it that it’s incomprehensible without an explanation then it’s shit code and I doubt you’d be able to write a comment that explains it that is not equally as shit as the code. Commenting on how shit code works cannot be trusted because the commenter has already proved they’re shit at the job by creating that shit code.

Best you can hope for is the comment contains a reason as to why the code is shit.

squaresinger ,

Found the junior dev.

h_a_r_u_k_i ,
@h_a_r_u_k_i@programming.dev avatar

“Code is the documentation” is the paradise we all want to be someday. But some people use that as an excuse to not write the documentation explaining why this piece of code exists in the first place. I find it extremely annoying when there is not a single architecture diagram is available and someone tell me to figure it out by reading his/her spaghetti code.

Von_Broheim ,

The problem is that code is language and people who write shit code tend to write shit comments, so no value is gained anyway. The sort of person who’d write good comments will most likely write good code where these comments are not needed, and when they intentionally write shit code they’d probably explain why.

So best you can hope for is that both of these people write comments about why they decided to write a comment, and hopefully the person who writes shit code improves over time.

Sotuanduso ,

Also, everone thinks they write good, clean and obvious code. Hardly anyone purpously writes bad, hacky code.

https://lemm.ee/pictrs/image/9e9e972d-1acd-47bb-8d32-7acde89a8bf9.webp

marty ,

This is the way. In ‘some’ cases comments are perfectly fine. Like when you need to document ‘why’ something was done the way it was our to link to a specific piece of documentation.

When you start commenting ‘what’ the code does, you code is not self explanatory enough. And those comments will get outdated and need refactoring too. Just more unnecessary work.

uberrice ,

If you think a block of code needs a comment, turn it into a method and give it a proper name instead.

Really depends. Yes, if someone doesn’t get what’s wrong with this statement, they should. But you shouldn’t wrap something in a method all the time just because. Sure, maybe you can make it an inline method, but usually, a method call takes time, and while it’s not a lot of time, in constrained or complex system that can accumulate. A lot. Sure, the compiler might optimize stuff away, but don’t just go blindly trusting your compiler.

Sure, a method call for something that gets called once a second is not a problem. But when you suddenly have thousands and thousands of method calls when say, you click a button, which calls method x which calls method x1 which calls y1 and y2 which call z1-10 and so on, then the method calls can suddenly turn into a problem.

Maybe not on a fast, modern device, but on an older or more constrained device. If your code never runs on there, sure, don’t bother.

traveler01 , in Shit Happens

I started to be more understanding of that after becoming a developer.

dylanTheDeveloper , in Always write comments
@dylanTheDeveloper@lemmy.world avatar

I just want variable names to be consistent. You do variableName then 5 lines down Jerry does a typo VariableNames and so Bob makes a function that’s gets it’s value from variableName and sets VariableNames with it 100 lines down because bobs tired and wants to go home.

Red1C3 , in Null terminator

Actually….it’s called NUL

Potatos_are_not_friends , in Shit Happens

Frontend developer: Listen I make pretty websites. This is a backend problem

whereisk ,

Backend developer: the buttons disappear only on smaller screens - looks like a frontend problem.

Aelorius , in Java

Logic, in math, if you have a real and you round it, it’s always a real not an integer. If we follow your mind with abs(-1) of an integer it should return a unsigned and that makes no sense.

kogasa ,
@kogasa@programming.dev avatar

in math, if you have a real and you round it, it’s always a real not an integer.

No, that’s made up. Outside of very specific niche contexts the concept of a number having a single well-defined type isn’t relevant in math like it is in programming. The number 1 is almost always considered both an integer and a real number.

If we follow your mind with abs(-1) of an integer it should return a unsigned and that makes no sense.

How does that not make sense? abs is always a nonnegative integer value, why couldn’t it be an unsigned int?

Aelorius ,

I’m ok with that, but what I mean is that it makes no sense to change the type of the provided variable if in mathematics the type can be the same.

CaptainHowdy , in Java

My God this is the most relevant meme I’ve ever seen

aequitas , in There is a language that punishes the programmer if they are not polite enough
graham1 OP ,
@graham1@gekinzuku.com avatar

Omg that’s so evil I love it

shukufuku , in There is a language that punishes the programmer if they are not polite enough

I’m disappointed that there’s not E089 PROGRAMMER IS NOT BEING SINCERE

graham1 OP ,
@graham1@gekinzuku.com avatar

PLEASE PLEASE PLEASE PLEASE PLEASE DO .3 <- !3˜#15’$!3˜#240

MarekKnapek , in Java
@MarekKnapek@programming.dev avatar

Makes sense, how would you represent floor(1e42) or ceil(1e120) as integer? It would not fit into 32bit (unsigned) or 31bit (signed) integer. Not even into 64bit integer.

natanael ,

BigInt (yeah, not native everywhere)

1rre ,

I feel this is worse than double though because it’s a library type rather than a basic type but I guess ceil and floor are also library functions unlike toInt

amanaftermidnight , in Shit Happens

People: “Please get this thing to work, my work/life depends on it!”
Me: “There are people whose work/life depend on my jank code/website?”

bleistift2 ,

Their life depends on it until it’s lunchtime. Then it doesn’t matter anymore. But woe to you if it’s not fixed when they’re back!

someone_secret , in There is a language that punishes the programmer if they are not polite enough

The Internet Historian learned how to program. Neat

graham1 OP ,
@graham1@gekinzuku.com avatar

Why do I need to be polite to a computer? Who is ’?.1$#256’˜’#256$#256’? And just what is E275 DON’T BYTE OFF MORE THAN YOU CAN CHEW? All this and more on this episode of In The Program

someone_secret ,

This episode is brought to you by Surfshark VPN

  • All
  • Subscribed
  • Moderated
  • Favorites
  • [email protected]
  • random
  • lifeLocal
  • goranko
  • All magazines