55

Today I created my first public repo... I've never commented my code so much.

Comments
  • 1
    Yup, same here
  • 6
    Don't worry.... it doesn't last long.
  • 1
    /** THIS FUCTION DOES STUFF.
    * THIS IS SOME OTHER STUFF.
    * @internal @details
    * THIS IS WHAT IT REALLY DOES
    * @arg a_foo Stuff 1
    * @arg a_bar Stuff 2
    * @returnd Stuff 3
    */
    std::string foobar(std::string a_foo, std::string a_bar) {}
  • 3
    My informatics teacher told us that we won't need any comments if our code is written good... Well
    ...
  • 2
    @ng1905 Good code almost reads as phrases, but comments can be added where necessary to explain how something fits in the greater whole.

    Tested code is more important than commented code in my opinion though.
  • 1
    That's good practice^^
Add Comment