DEV Community

Discussion on: How do you document code?

Collapse
 
iamschulz profile image
Daniel Schulz

I'm all for self explaining code and long, declarative function names. However I see them more fitting for describing "what" the code does and rather limited for "why". Whenever I try to adopt third party code I find it much more challenging to understand the architecture than the methods.

I just included wikis for the sake of completeness. I had to document in confluence in the past and found it very problematic. It kept being forgotten, out of date and cumbersome. No recommendation from me.