Unnecessary Commenting

you're not half as smart as you think you are.

most of your comments are just commenting what the line is doing, only two of them have any indication of why you're doing what you're doing.

your pic isn't the worst code I've seen, but it's a long way from being good code.

>What we need is formal comment verification.
You can put tests in Rust comments to make sure they stay up to date.

That code looks like shit. Apply yourself

It's so fucking simple to just add a line that says what it does, it even HELPS you later when you look back on your old code. Like months later

That's fucking neat. Too bad I'm not touching Rust with a 10 ft pole

I thought I was totally straight. Then I discovered Rust.

>its NOT bad code
Its bad code, you litterally only commented things that you don't need to comment. What the fuck is the point in this?

intAnswer = RollDice(); // Role for next guess
or this:

if(intRoll == 3) { //If roll is 3, add 2
intTotal += 2;
}
those comments are just plain unnecessary.

pretty much this

Your comments are garbage. You should add comments to clarify why you are doing something, not what you are doing

So, let's say my code looks like shit. WHY does it look like shit? You don't like my formatting? Do you guys just prefer K&R?

Who needs help figuring out what a 5d6 roll and a case statement does? Those comments were added specifically because I was penalized for not having them. I honestly, to the best of my ability, tried to add comments for people who somehow couldn't understand what I was doing. They, unsurprisingly, have no value whatsoever.

It's a win/lose condition and a dice roll function. What exactly do you need to know about?

I can understand what is going on because everything is clearly labeled and self explanatory. I work 8-5 on coding, and more often than not the comments are either of no use at all and it seems as though the code just needs to be refactored in the first place. is right. Almost none of the comments that I see in older code actually give me any value whatsoever. If anything, they throw me in the wrong direction.

In my opinion, none of what I wrote needs any explanation whatsoever. I just threw comments in there because they were required. Are you going to point out anything negative other than the comments?

Again, what is confusing about a win/lose state and a dice roll?

Why am I rolling dice in a game? Why does having the correct answer mean that you get a point?

I'm just missing it, I guess.

I'd like to look into this more. Good links on this?

I've been where you are. Comments are important, though. You might think it's a waste of time, but if your comment saves somebody 1 minute of trying to figure something out, then it paid for itself. And usually it will pay that time back many more times than that, especially for A) large projects and B) projects where you are working with others. I'm an independent game dev who never works with anybody and I still comment everything because there's literally no reason not to.
>just remember everything bro
I have the best memory out of anybody I know. Everybody forgets how their code works and has to re-read it. The only people who disagree with that are college kids who have never worked on a big project. Simple fact.

uninitialized variables (int intRoll), not combining common cases (if (... == 3) ... else if (... == 5), and magic numbers everywhere. Quality code.

It's not clear to me what intTotal is and the comments don't help. They just describe the line of code, not the thinking behind it. Thanks, I can read the code myself but I don't know what you were thinking when you wrote it.

Funny you mention game dev. I went through an engine and a game (id tech 2 and unreal tournament) to understand how the code worked. Zero comments. And I understood pretty much everything. With modern editors you can find references, jump from calls to declarations to definitions, navigate files in huge code bases. It’s just not very complicated to understand how something works from its code itself. Hell, I don’t usually comment a lot and I have no problem understanding my programs a few months after I stopped working on them. If you follow clean code principles and good software development practices and refactor a lot, your code won’t become a mess of spaghetti that can’t be understood.

When a file gets particularly long i like to add a comment before each method just to state what it'll do. I think it helps even if all the naming is spot on.

The difference being that I have been writing my own code as well as maintaining poorly written and even moreso poorly commented code professionally for a year now.

A. Does intRoll NEED to be initialized given the scope?
B. Can you give me one reason why a case/switch statement provides any benefit over an if/elseif/else for a situation that only permits three distinct possibilities?

if (x == 1){
DoThis();
} else if (x == 2) {
DoThat();
}

Is much better than

Switch (x){
case 1:
DoThis();
break;
case 2:
DoThat();
break;
default:
break;
}

If anything, this makes more sense but would be more likely to confuse the reader:

if (intRoll == 1 || intRoll == 2){
intTotal += intRoll - 1;
}

intRoll is the value of the current die being rolled. intTotal is the total value of all dies that have been rolled. There are five die being rolled. As you can read there. Plainly.

Blasphemy. I got my start by changing source code in games to cheat. My close friend became a Doom modder.

>if roll is 3, add 2
Yes I can see that, I'm not retarded. But why? Why would you add only 2 if intTotal is the total? Why add 4 if the roll is 5? Why add nothing if the roll is 1, 2, 4 or 6? That's not what a total is. Maybe there's a good reason, but I don't see it from the code. And yes, "add 2 if roll is 3" is an unnecessary comment because everyone can see that.

These comments are meaningless. You're saying what the line is doing when it's obvious instead of why you're doing it.

(me)
Also, I can see that you roll 5d6 from the code. The comment could be omitted but it doesn't hurt.

>The truth is that it didn't need comments, as everything was either labeled through #region's or was self explanatory.
Typical code monkey.
In a couple of months you'll look back at it and be like "what the fuck is that doing"?

Why does intTotal only increase if you roll a 3 or 5, and increase by 5 or 9 respectively in those cases?
The comments sound like it should be a total of all dice rolled.

I wouldn't expect a comment if it were intTotal += intRoll. Yeah, makes sense, a total is just the sum of all rolls. But why roll - 1? Why only in some cases?

I'm expecting OP to in a minute go
>aha i put a bug in the code to show how easy the code is to read so that you can see that comments are not necessary!
Except it's because of the comments that we can tell the code isn't doing what it should be.

>The truth is that it didn't need comments
It's a best-practice because you're going to work with other programmers, or someone may be asked to maintain your software or write middleware for it. That's why you deserved a 50% penalty on your assignment.

>wants high salary from corporations that demand following strict procedure and protocol
>cannot follow loose academic protocol and procedure to obtain high GPA degree for said job
Never gonna make it.

To be DESU, you are going to acquire absolutely no value questioning why your academic setting wants you to comment, as you yourself don't see value in it, and you are too big-brain (yet prideful) to lower yourself to the subservient student role. Don't ask "why" for anything, because you already formulated the "why not" in your egomind. Go research why/when/how you should comment, and follow the most based answer - or blaze your own path.

You sound like you can do good work, so no sweat there. Work on your social cooperation/appeasement skills or go balls blazing and embrace whatever may come of it. Just don't do so ignorantly, and don't ask for (You)s for this shit again.

I look back at my code, as I've said on multiple occasions, all the time. You're just plain wrong. I can read what I write very easily.

This is implicit it the game which I am writing, called PetalsAroundTheRose. I have explained this in earlier comments. The only dice worth points are 3 or five, and the dot in the center does not count toward the points.

The code actually works perfectly and has been tested for bugs. None exist. I really have no idea what you're on about.

I already work with other programmers. They don't need comments except in special occasions, either.

I already work for a fortune 200. Speak for yourself.

I'm looking for insight, and I got some. Lots of people clearly share similar ideals, and others can't read.

And no, I won't humble myself to someone who never actually had to ability to work in the private sector and instead gatekeeps theoretical practices. I want to get my degree so I can get past the HR schmucks.

I have the skills needed as a professional, and my managers keep providing me with opportunities to advance because they see what I've been able to do for them. I think it's very depressing that so many people here judge me so harshly because of the little snippet of code that doesn't use the concepts they deem holy.

>Is there something I'm missing here? Should this hand holding really be enforced?
You're in school. You are expected to comment your code with with, at minimum, your entire pseudocode algorithm interspersed as appropriate.

Guess how we can tell that you're larping.

Sorry that my existence makes you uncomfortable.

But I'll bite, user.

How do you know that I'm larping?

If you were skilled and successful you wouldn't sound like a whiny bitch.
And that's the very least of it for starters.

That settles it, then.
I am not a real person.
Thanks for clearing all of that up.

...

Commenting code is like checking the mirrors while driving; you make a show of doing it when the instructor is watching. When you pass the test and progress to serious coding / driving you stop

Same reason if you take a physics class that you have to explain what you're doing when you solve a problem. It's to show you understand the solution, and if your solution is incorrect or doesn't work, they can give you points if you showed understanding of what the solution would be, even if you couldn't produce it yourself.

>student
>can't follow directions
>struggling with highschool computer class-tier problems
>works for "a fortune 200"
You got too greedy on your character sheet.

>they can give you points if you showed understanding of what the solution would be, even if you couldn't produce it yourself.

What the fuck? Why are they rewarding failure?

They aren't teaching coding, they're teaching programming.

I think someone needs to teach them common sense

>I have to get a degree to get the salary range I want.
OH NO NO NO

Attached: 1567203813973.jpg (800x450, 61K)

Yes. Comments are useless, except for removing code without deleting it.

What I did in assignments was to always write the most banal and useless comments imaginable, like:
a=b; //sets a to b
for(i=1;i

>Pic attached is NOT bad code
it's another episode of the student/graduate who doesn't know how fucking garbage they are at programming and gets defensive at the first hint of (admittedly bad in this case) critique from someone who knows better than they do

My solution is right and it's provably right. It is necessary to write every proof in Calculus, too?

>struggling
Where?
>can't follow directions
Just because someone can subtract points from my assignment doesn't make them right - at any point in time.

My guess is so that they can push more cattle through college.

I've asked repeatedly to demonstrate why my code was shit. There were good points, but most were garbage.

>I've been in a programming in a programming position for over a year
Then you should know you must always comment every function you write especially in java so that the code documentation/java doc is made

Welcome to uni, it's basically worthless

Dude, this code kind of sucks and your comments are worthless. You're restating obvious shit instead of explaining what isn't obvious. Ask your professor to refactor it with you if you don't like the grade so you can see what they'd change, but this is competent code, not good code.

No one would accept this at my job. You were being treated with kid gloves at yours.

>first year cs student finds out that people want comments to be able to maintain your shitty pajeet fiesta
CALL THE PRESS

t. freshman with no actual experience in the field

As someone who can't read code very well, comments explaining what something does are very helpful.

No no no, can't you see? OP is a super genius that knows better than teachers and they are just holding him back.

wh*toid programming professors be holding him back he gud boy he dindu comment

This code needs no comments, but if it was specifically mentioned to add comments, then docking points is justified. In your RollDice(), intRoll should be inside the for block.

They are grading your understanding of physics. If the failing point in your solution was not related to physics, it seems unreasonable to give a low grade.

Still doesn't change the fact that you would have understood it faster with good comments. With a good comment, you don't even have to read the main part of a function at all.

What exactly needs refactored here?

Checked

If they are teaching me to take it in the ass, I guess you're right.

Valid point,

If you're not reading the code, how can you accurately describe the code? I cannot trust comments after them being blatantly wrong so many times.

>This is implicit it the game which I am writing, called PetalsAroundTheRose.
Guess how you can make this explicit.

>inconsistent style
>regions named after the function, don't bring any more information than function names
>regions for a single function
>comments his procedural code by commenting procedural operation, but not explaining the abstracted concept behind the operation

>""NOT bad code""

lmao @ ur life, kid

I'm actually ashamed

>tfw when write my whole thought process in commit messages which sound funny in the end, and use comments to further clarify even tho no one is going to read them.

Attached: 1544036862595.png (227x186, 19K)

>//if roll is 4, add 2
>//if roll is 5, add 4
this isn't what comments are for
i can see what the code is doing, but what's not obvious is why you're doing this
why are you adding 2 when the roll is 3? explaining this should be the comment

How can you miss these niggas point so many times? You are truly a pajeet.

If you doubt the correctness of comments, there's no reason to have comments at all, you're right. But then make sure that you don't have wrong statements in the comments.