This is an archived version of the course. Please find the latest version of the course on the main webpage.

Chapter 10: Commenting

Documenting your robot

face Josiah Wang

Now, look at your code from your robot project.

Try to figure out where you may need to provide comments.

And then include informative comments in your code where needed.

Again, use my guideline: if someone else (or you) from the future cannot understand your code, then include some comments to make life easier for them (or your future self).

Your future self will be eternally grateful! 🙏🙏

And once you’re done, remember to commit your latest update to your repo!

You can find my implementation of the robot project so far by following this Gitlab link. This is not necessarily the best implementation - there might be better solutions (depending on your aim). I have put myself in your shoes and followed along the exercise as how you would have done it, based on only what we have covered so far.