[Help] Help me check my comments

[exjames1991]

I've written a program but I don't know whether my comments are correct, suitable or missing. Please help me to check , I've put the "??" because I'm not sure about it.

This is my code

#include <stdio.h>

/* function main begins program execution */ 
int main ()

{
	int i, j, tmp; /* initialize integers */
	int num[10] = {5,6,3,2,8,9,0,4,1,7}; /* 10 unsorted arrays */

	for (i = 1; i < 10; i++) /* number of loops */
	{
	for ( j = 0; j < 10; j++) /* ?? */
		if (num[j] > num[j+1]) /* ?? */
		{
			tmp = num[j]; /* bubble sort formula */
			num[j] = num[j+1];
			num[j+1] = tmp;
		}
		printf("loop %d", i); /* prints loop */
		for (j = 0; j < 10; j++) /* total numbers in a loop */
			printf("%4d", num[j]); /* prints distance between numbers */
		printf("\n"); /* begin new output line */
	} /* end outer for */
} /* end function main */

[RockyMarrone]

#include <stdio.h>

/* function main begins program execution */ 
int main ()

{
        // Variable Declaration
	int i, j, tmp; 
        
        // Declaring and initializing an unsorted array of integers
	int num[10] = {5,6,3,2,8,9,0,4,1,7}; 

	for (i = 1; i < 10; i++)
	{
	for ( j = 0; j < 10; j++) 
		if (num[j] > num[j+1]) 
		{
			tmp = num[j]; 
			num[j] = num[j+1];
			num[j+1] = tmp;
		}
		printf("loop %d", i); 
		for (j = 0; j < 10; j++) 
			printf("%4d", num[j]); 
		printf("\n");
	} 	// end of for (i = 1; i < 10; i++)
}

First of all i want to say that u don't have to comment each and every line of code
comment is necessary where u think logic is complex and by reading simple words
any body can pick up the logic......

[tabstop]

I've written a program but I don't know whether my comments are correct, suitable or missing. Please help me to check , I've put the "??" because I'm not sure about it.

This is my code

#include <stdio.h>

/* function main begins program execution */ 
int main ()

{
	int i, j, tmp; /* initialize integers */ /*This is incorrect, as these integers are uninitialized*/
	int num[10] = {5,6,3,2,8,9,0,4,1,7}; /* 10 unsorted arrays */  /*This is incorrect, as this is one array of 10 numbers */

	for (i = 1; i < 10; i++) /* number of loops */
	{
	for ( j = 0; j < 10; j++) /* ?? */
		if (num[j] > num[j+1]) /* ?? */  /*If you don't know what > means, you're in a lot of trouble */
		{
			tmp = num[j]; /* bubble sort formula */  /*There is not and cannot be a "bubble sort formula" */
			num[j] = num[j+1];
			num[j+1] = tmp;  /*If you needed a comment at all for these three lines, it would be "swap num[j] and num[j+1]" */
		}
		printf("loop %d", i); /* prints loop */
		for (j = 0; j < 10; j++) /* total numbers in a loop */
			printf("%4d", num[j]); /* prints distance between numbers */  /*This is so amazingly incorrect */
		printf("\n"); /* begin new output line */
	} /* end outer for */
} /* end function main */  /*You should never comment "end of <whatever>"; that's what indentation is for */

My comments in red. Also agree with "way too many comments".

[Adak]

I've written a program but I don't know whether my comments are correct, suitable or missing. Please help me to check , I've put the "??" because I'm not sure about it.

This is my code

#include <stdio.h>

/* function main begins program execution */ 
int main ()

{
	int i, j, tmp; /* initialize integers */  //remove
	int num[10] = {5,6,3,2,8,9,0,4,1,7}; /* 10 unsorted arrays */ //1 unsorted array.

	for (i = 0; i < 9; i++) /* number of loops */ //starting bubble sort change range from 0 to 9. i is the "lower" variable. j is the 'upper" variable.
	{
        /* your sort is comparing num[j] with num[j+1]. When j == 9, j+1 is outside the array. Your comparison should be num[i] with num[j].
	for ( j = 1; j < 10; j++) /* ?? */ //you need baces added to this for loop
		if (num[j] > num[j+1]) /* ?? */ //if num[i] > num[j]
		{
			tmp = num[j]; /* bubble sort formula */ //swap
			num[j] = num[j+1];  //num[j] = num[i]
			num[j+1] = tmp;      //num[i] = tmp;
		}
		printf("loop %d", i); /* prints loop */ //remove comment
		for (j = 0; j < 10; j++) /* total numbers in a loop */ //remove comment
			printf("%4d", num[j]); /* prints distance between numbers *///should be num[j] - num[i] or some subtraction going on here
		printf("\n"); /* begin new output line */ //remove obvious comment
	} /* end outer for */
} /* end function main */

Lines of code that are totally self explanatory, need no comment. Comment a few to guide a new reader, into what the code is doing, and how. That, and anything odd, that wouldn't be clear at first look, when seen by another programmer.

That is all the comments you need, or want.

I find adding ending loop comments helpful like: "end of outer for... whenever the loop is large enough that I can't see the whole loop, on the screen, at one time.

[Dino]

In professional code, comments will tend to be aligned vertically where it makes sense.

When adding comments, you are adding them for yourself and others, but more importantly for others, so direct your comments to the others who will follow and who will be trying to fix, enhance, or perhaps even grade your work.

[exjames1991]

Thx alot guys, now I'm more clear and understand to how bubble sort works.

[iMalc]

The most important thing when commenting code in the real world is not to say what the code is doing, but to say why it is doing it!
The worst thing you can do is something like this:

i++; // increment i

The only kind of person that would help would be one who doesn't know the C language and does know the meaning of increment. In reality, such a person will probably not be having any contact with your code, ever.

Having said that, commenting for an assignment is sometimes slightly different from real-world commenting because it can help to show that you understand what is going on. Just don't do too much of that. It is just as easy to over comment as it is to have too few comments.

Next point: You are overrunning your buffer. j goes from 1 to 9, and your if statement accesses item [j+1] That's item 10 in an array that only has valid indexes of 0 to 9 (arrays start at zero).

[exjames1991]

As to my understanding,

	tmp = num[j]; /* swap */
	num[j] = num[j+1]; /* num[j] = num[i] */
	num[j+1] = tmp; /* num[i] = tmp */

It says that num[j]=num[j] and num[j+1]=num[i] but how come in the code below says that num[j]=num[i].

if (num[j] > num[j+1]) /* if num[i] > num[j] */

And for this

printf("%4d", num[j]); /* num[j] - num[i] */

Why is num[j]-num[i]? What are J and I differences and what are them?
Please help me to clarify.

[tabstop]

As to my understanding,

	tmp = num[j]; /* swap */
	num[j] = num[j+1]; /* num[j] = num[i] */
	num[j+1] = tmp; /* num[i] = tmp */

It says that num[j]=num[j] and num[j+1]=num[i] but how come in the code below says that num[j]=num[i].

if (num[j] > num[j+1]) /* if num[i] > num[j] */

I'm thinking that's just where Adak forgot how bubble sort works. (You should be having j and j+1 like you do, just keeping j in bounds (0 through 8 instead of 1 through 10.)

And for this

printf("%4d", num[j]); /* num[j] - num[i] */

Why is num[j]-num[i]? What are J and I differences and what are them?
Please help me to clarify.

There he changed your code to match your comments -- your comment said you were printing the differences, so he changed your code to print the difference.

[exjames1991]

Moderators, please close and lock this thread so prevent any illegal act or abuse. Thank you

[exjames1991]

10 letters long **** **** ****