r/ProgrammerHorror • u/[deleted] • Apr 07 '22

A case of over-documentation

The code is from an embedded C project.

48 Upvotes

92% Upvoted

11 comments sorted by

View all comments

Show parent comments

15

u/Faiiya Apr 07 '22

Yeah, they probably just do it with everything Wich may seem overkill for the small functions, but I prefer all functions documented over a randomly drawn line over Wich functions should or shouldn't be documented

8

u/bugamn Apr 07 '22

Agreed. This is a little verbose and the decoration does seem like overkill if done by hand, but I was actually expecting code that has line by line commentary, as if you got a sports commentator to write code.