Posts tagged Documentation
-
Finding the right level of documentation
Writing only meaningful documentation reduces confusion and leaves devs with more time to code. Use simple tools to get the job done.
I was asked for my thoughts on code documentation today and realised how much my approach has changed over the years. In my eager early days of development, I thought the mark of a true professional was someone who, in addition to writing quality code, also took the time to document it beautifully. I added block comments to classes and methods and sprinkled helpful inline comments throughout my code. These days, I take a very different approach.