Every story and comment from the Hacker News API, in a layout borrowed from 2001.
A comment on Writing system software: code comments. Parent comment
Better question: “What feature am I missing from my current PL or API that would mean I didn’t need this comment/documentation?”
Then strive to get that built.
For example a type system removes the need for an entire kind of method comment.
DSLs are excellent at this. Lombok removes the need for an entire kind of class comment.
Convention over configuration is great at this. Rails routes removes the need for an entire kind of comment.
Moving optimization’s into the compiler are good for this. Removing the need for an entire kind of comment.
Rust’s borrow checker removes the need for an entire kind of documentation around concurrency.
Every time a PL or library gets more advanced/ergonomic it removes the need for an entire kind of documentation.
Why shouldn’t we strive to take this to the limit, making better and better PLs and libraries till we need 0 documentation?
There are no comments on this comment yet.
Better question: “What feature am I missing from my current PL or API that would mean I didn’t need this comment/documentation?”
Then strive to get that built.
For example a type system removes the need for an entire kind of method comment.
DSLs are excellent at this. Lombok removes the need for an entire kind of class comment.
Convention over configuration is great at this. Rails routes removes the need for an entire kind of comment.
Moving optimization’s into the compiler are good for this. Removing the need for an entire kind of comment.
Rust’s borrow checker removes the need for an entire kind of documentation around concurrency.
Every time a PL or library gets more advanced/ergonomic it removes the need for an entire kind of documentation.
Why shouldn’t we strive to take this to the limit, making better and better PLs and libraries till we need 0 documentation?