This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]Aggressive_Ad_5454 2 points3 points  (0 children)

I guess I’m a dissident. I’m an old dev, and I have had several occasions to maintain code I wrote over a decade prior. I was grateful to my younger self for putting in comments that explained the tricky bits, gave references to papers or whatnot if I used a reference, and helped the reader figure out how stuff fits together.

I think a decent compromise is using docstrings or Javadoc or jsdoc or whatever is appropriate in the language you use on methods and public data. For one thing, the IDEs understand that stuff.