New Newsletter! The Myth of Self-Documenting Codehttps://buttondown.email/hillelwayne/archive/the-myth-of-self-documenting-code/ …
-
-
Pretty much this too. One block of documentation especially for context helps me tremendously to remember what something was about.
Thanks. Twitter will use this to make your timeline better. UndoUndo
-
-
-
I really like the NOTE approach in GHC - notes are long comments with a name and explain invariants, decisions, or algorithms. Then they are referenced like `Note [Depend on GHC.Tuple]`https://www.stackbuilders.com/news/the-notes-of-ghc …
-
This way readers know which comments are relevant, even across files. And you can use code search to figure out where an invariant/concept is important while refactoring!
End of conversation
New conversation -
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.