-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Add comments to all algorithms #630
Copy link
Copy link
Closed
Labels
code qualityCode quality improvementCode quality improvementfeatureAdds a new featureAdds a new featurehelp wantedNeeds to be worked onNeeds to be worked on
Description
One of the main purposes of this repository is education. But for that, a comprehensive explanation of the various algorithms along with the mentioned references is required. This is achieved through well-commented code, but that is missing from many algorithms. This issue tries to start work on commenting on all the algorithms and establishing a good format for commenting. We also should check all new Pull Requests for code quality and comments.
A format suggestion for commenting:
/*
* Complete explanation of the given steps of the algorithm
* along with manual word wrapping.
*
* Using paragraphs, diagrams, and tables wherever
* required.
*
* ┌──────────┬───────┐
* | Row 1 | Row 2 |
* ├──────────┼───────┤
* | Column 1 | 1,2 |
* ├──────────┼───────┤
* | Column 2 | 2,2 |
* └──────────┴───────┘
*
* References:
* List of references used in the above-given explanation
* from various sources.
* Each on a separate line.
* https://en.wikipedia.org/wiki/Box-drawing_character
*/Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
code qualityCode quality improvementCode quality improvementfeatureAdds a new featureAdds a new featurehelp wantedNeeds to be worked onNeeds to be worked on