search

alvawei / smerge

3 stars 3 forks source link

Comments #1

Open Juliusc01 opened 6 years ago

Juliusc01 commented 6 years ago

When taking a look at various classes, we noticed that while some are well commented, many were missing comments at the top of the class to explain it, and some classes had no comments on the methods in that class, like: Action Set. Delete, Update

Juliusc01 commented 6 years ago

Some descriptions of the methods seem vague and too specific ex: match comment is quite specific and technical. Other then that comments on public methods look good, are short and concise which is good.

connerknight commented 6 years ago

Decided to review comments since they are an important resource to quickly determining the purpose and functionality of different files/functions of your code.

sarahsz commented 6 years ago

I also noticed an inconsistency in comments- some methods have comments some don’t