Suggestion for codes in editorials

KazmetreD's blog

By KazmetreD, 2 years ago, In English

Sometimes when I read "Tutorial" section for a problem, I get what it says but I can't code it. So I look at "Solution" section and try to understand. Then I realized that, it would be much better if there was some comment lines to explain how that code works.

Let me give an example:

Example

#include <bits/stdc++.h>
using namespace std;

int main(){
	
	int n;
	cin >> n;
        //Here we are getting size of the array

	int mx = 0;
        //Defining variable that we will store value of the maximum element

	vector<int> arr(n);
	for(int i = 0;i < n;i++)
		cin >> arr[i]; // Getting elements of the array

	for(int i = 0;i < n;i++)
		mx = max(mx, arr[i]); // We are comparing the elements of the array with the variable x and
                                      // writing the big one inside the variable.

	cout << mx << "\n";
        // Printing the answer

	return 0;
}

This is too easy and detailed. But you got what I want to say.

editorial, comments

KazmetreD
2 years ago
5

Comments (4)

Show archived | Write comment?

ssvb

2 years ago, # |

+19

I'll just leave this link here: Best practices for writing code comments

→ Reply

nskybytskyi

2 years ago, # |

I agree that comments may sometimes help you understand the code better. However, when I don't understand something in the editorial code it mostly comes from the difference in coding style, not the absence of comments. Understandably, this is to be expected, as the code in editorials is written by different problemsetters and testers.

To that matter, I would suggest reading not only the editorial code but also the submissions of other higher-rated people. Eventually, you are likely to find multiple smart people whose coding style is similar to yours and understand their code easier than the one in an editorial. Hope this helps :3

→ Reply