• EnderMB@lemmy.world
    link
    fedilink
    arrow-up
    2
    ·
    1 year ago

    No, commenting a function should be commonplace, if not only so that your IDE/editor can use the documentation when the signature is found elsewhere in your code.

    Within a function, though, basically means that something gnarly is happening that wouldn’t be obvious, or that the function is doing more than it (probably) should.