Re:I’m a productive programmer with a memory of a fruit fly
by seti0Cha on Monday September 19, 2022 @03:11PM
(#32902575)
I'm in exactly the same position. My memory is awful so I write notes to my future self. It's not hard to keep comments up to date if you keep them near the code and don't use a lot of boilerplate.
[ Parent
| on HN ]
Re:I’m a productive programmer with a memory of a fruit fly
by timr on Monday September 19, 2022 @03:16PM
(#32902637)
> It's not hard to keep comments up to date if you keep them near the code and don't use a lot of boilerplate.
Yep, exactly. It only gets "complicated" when you start having these heavy-handed doc generators that are parsing your code and breaking the build.
I feel pretty strongly that sphinx, rubydoc, python docstrings et al. are fine tools, but you have to have a light touch with how they're applied. Autogenerated external docs are a separate problem, and shouldn't discourage developers from commenting their code.