Threads

This profile is from a federated server and may be incomplete. Browse more on the original instance.

A breakdown of how the Redis source code got comments right. (antirez.com)

Comments should provide context, not repeat what the code already says. The Redis codebase has 9 distinct types of comments (Function, Design, Why, Teacher, Checklist, Guide, Trivial, Debt, Backup), each with a specific goal in mind.

The Grand Unified Theory of Documentation (AKA: Your project needs all 4 types or you have bad documentation) (documentation.divio.com)

The mistake most devs make when trying to document their project is that they only make one (maybe two) types of documentation based on a readme template and/or what their mental model of a newcomer needs....

  • All
  • Subscribed
  • Moderated
  • Favorites
  • provamag3
  • everett
  • ethstaker
  • thenastyranch
  • magazineikmin
  • Leos
  • rosin
  • khanakhh
  • osvaldo12
  • Youngstown
  • slotface
  • Durango
  • kavyap
  • DreamBathrooms
  • JUstTest
  • ngwrru68w68
  • GTA5RPClips
  • InstantRegret
  • anitta
  • cubers
  • mdbf
  • cisconetworking
  • tacticalgear
  • tester
  • megavids
  • modclub
  • normalnudes
  • lostlight
  • All magazines