DEV Community

Discussion on: Don't document your code. Code your documentation.

Collapse
 
sudocat profile image
Robin Neal

No. While I love some well written code, clear in meaning, it is by no means a substitute for documenting your code. I shouldn't need to dig through what is sometimes hundreds of files and thousands of lines of code just to find out how to do work with a project. It doesn't matter how clear code is, it cannot describe your entire code base, or the far reaching side effects.