this post was submitted on 28 Jul 2023
1087 points (99.0% liked)

Programmer Humor

32567 readers
153 users here now

Post funny things about programming here! (Or just rant about your favourite programming language.)

Rules:

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

> I produce text or HTML files anyway

I do extensive in-code documentation. The compiler discards all comments so I don't worry about commenting my code. Source code is for humans to understand and write anyways.

[–] [email protected] 4 points 1 year ago (1 children)

Oh, yeah. My source code is like 60% comments by weight (or more). Although I typically produce separate standalone documentation for management or semi-technical staff. You know, people who know enough to possibly break something, but not enough to fix it afterward. I find it useful when trying to train new people too.

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

User-facing documentation is a completely different thing, yes.

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

Also writing documentation in-code like JavaDoc or equivalents has always seemed great for me. Then you can have your toolchain generate the written documentation directly from that, and it can be updated easily based on what's actually documented in the code (but that does require that people keep that updated)