Closed ziyi105 closed 1 year ago
Does commenting in the method count?
You can explain what the method does in the header comment. Commenting inside the method doesn't count as header comment.
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?
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 :-)
alright, thank you!
in that case, do I still need to add comments? If I don't will the marking script mark me down?