nus-cs2113-AY2324S1 / forum

0 stars 0 forks source link

A-JavaDoc, most of my public methods are self-explanatory #22

Closed ziyi105 closed 11 months ago

ziyi105 commented 11 months ago

in that case, do I still need to add comments? If I don't will the marking script mark me down?

ziyi105 commented 11 months ago

Does commenting in the method count?

okkhoy commented 11 months ago

You can explain what the method does in the header comment. Commenting inside the method doesn't count as header comment.

ziyi105 commented 11 months ago

Most of my method names are very straight forward, like addTodo(), getSize(), readFile(), run(), printHelloMessage(), if i comment on them isnt that repeating the obvious?

okkhoy commented 11 months ago

hmmm... valid point! the baseline I normally suggest is this: anything other than a getter/setter is a non-trivial method; add comments to all non-trivial methods :-)

ziyi105 commented 11 months ago

alright, thank you!