Re:Reducing technical debt by valuing comments as much as code
by davidw on Wednesday February 01, 2023 @09:58AM
(#34611319)
> actual documentation was already written in the internal wiki
I think that's a reasonable approach if it's easy to find the relevant section of the wiki that describes the code you're looking at by searching. Or just have a comment in the code that points to the wiki. The important thing is to document the "why's".
I think that's a reasonable approach if it's easy to find the relevant section of the wiki that describes the code you're looking at by searching. Or just have a comment in the code that points to the wiki. The important thing is to document the "why's".