Skip to content

commenting #4

@cbedwards-dfw

Description

@cbedwards-dfw

https://phac-modelling-hub.github.io/dev-practices/day-to-day/commenting.html

Not sure if you want to mention it here, but it took me way too long to recognize the hidden cost of excessive commenting. If I comment a ton, and then come back and revise the code, unless I'm careful a lot of the excessive comments will be out of date. My more heavily commented documents that have grown organically over time are often equivalent to uncommented, since many of the comments can't be trusted.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions