21
C0D4
3y

No matter how much documentation you write, and how well you comment the code, the truth is always the code itself.

Comments
  • 3
  • 5
    So, instead of reading the whole fucking documentation, we should read the whole fucking code
  • 10
    Documentation is the guide for the code. Not a replacement
  • 4
    Yeah, download the linux kernel source code yourself because you know fuck documentation
  • 2
    @Eklavya 👀 I didn't say that

    Wow you guys go straight to the problem on this one. Documentation can lie or be outdated, so yes it's usually incorrect making the code the source of truth, should you have to read the code to understand what's going on? No.
  • 0
    @C0D4 whenever I make sth i take a page from the REACT documentation site, it has everything you will ever need to know about the framework and that's really sth.
  • 1
    @C0D4 actually, you do have to read it to understand the code quicker (if it is up-to-date, of course)
  • 7
    one could also argue:
    if your code does not match docs that's a bug, because it does not behave like documented.
  • 2
    @nebula but in many cases this is a bug in the documentation ;). But yes, still a bug.
  • 0
    @Voxera jeah sadly documentation is often left behind :/
  • 0
    Documentation should come first otherwise you are just winging the project
  • 2
    Unless the code is in emojicode then you're f'd!

    https://tio.run//...
  • 0
    Burn him at the stake guys.Time to get devRant cancelled 🤣
  • 0
    @arcadesdude oh, for fuck's sake...
  • 1
    We need a "Document this dick!" t-shirt
  • 0
  • 1
    Documentation? What's that? Is it to eat? Is it to drink? Is it an animal? Is it a plane?

    My dream is founding a documented project
Add Comment