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.
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)
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.
You are not logged in. However you can subscribe from another Fediverse account, for example Lemmy or Mastodon. To do this, paste the following into the search field of your instance: !programmerhumor@lemmy.ml
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
Posts must be relevant to programming, programmers, or computer science.
No NSFW content.
Jokes must be in good taste. No hate speech, bigotry, etc.
> 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.
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)
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.
User-facing documentation is a completely different thing, yes.