27
Sayaka
7y

What else am I supposed to put in the function comment...

Comments
  • 3
    In my opinion could should be readable by itself, except apis.

    And of course sometimes there is a piece of code that needs a comment.

    This forces you to write better code and if you need some hint what the line does you could look in the versioncontrol
  • 1
    @TheNewGuy Well it is readable by itself - that only exists so that the function shows up in Doxygen
  • 0
    and you have to maintain the comments - as they are always possibly outdated
  • 0
    @CraftedCart kk
  • 0
    @TheNewGuy some IDEs will warn you if the Jsdoc markup is out of date
  • 0
    @620hun

    you will still have to maintain the comments - and I am lazy :P
Add Comment