0
AceDev
1y

Doing what I dislike... documentation.

and I have to make the readme files for every directory within the codebase.!!

Comments
  • 3
    Why a read me file for every directory? What's the point?

    Isn't general code structure enough + comments on each file? Especially beginning of file description? I usually add those at the top to give a quick overview of what this file is for, assuming my file name isn't clear enough to explain this
  • 0
    You're basically doing documentation comments (e.g. javadoc) in separate readme files :)
  • 2
    Readme in every dir?! Unless you've only got a handful of top level dirs, challenge whoever told you to do that nonsense.
Add Comment