3

How do i learn to do proper commenting in my projects?

Comments
  • 3
    Welcome to devRant!

    General advice:
    Don't explain the language.
    If you're using an abbreviated variable name usually good to comment explaining what it's abbreviated.
    Doxygen is important, basically function documentation explaining input/output/purpose of a function when not apparent from the function name.

    Something you'll learn from experience. Go find some code you wrote 6 months ago and try to work out what it's doing. Anything that's hard to work out should have been commented.
Add Comment