this post was submitted on 03 Aug 2023
490 points (99.4% liked)

Programmer Humor

19653 readers
1283 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

founded 1 year ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 16 points 1 year ago (2 children)

This is why having a dedicated person/team to maintain docs is very important

[–] [email protected] 13 points 1 year ago

I've always felt that programmers need one day out of the week where they explain what their code does to someone dedicated to writing documentation. That way the code is being documented while you still understand what it does and the documentation is constantly being updated.

[–] [email protected] 7 points 1 year ago

Also why having doc comments and docs generated from code are super useful. When someone changes the code but not the comment above, it becomes really obvious that something was missed as opposed to having code and doc changes be two separate tasks.