Hacker News new | ask | show | jobs
by pc86 1837 days ago
If it's impossible to make "what" clear through the code itself.
2 comments

With a public API it's important to distinguish "currently true from reading the code" and "promised to stay true through minor updates". What comments are useful for that
If a method is part of an API that might be used by developers external to your team, they don’t want to be looking through your code to figure out how to use your methods.