3) The coding standard permits a one line description of the file as the
third line, juat after the file path.  People do not often use this, but
I think it should also be permitted.  It certainly helpful having a one
liner telling you what the file is.
I agree, and I'd even propose to make that a requirement. There's nothing
worse for a newbie trying to figure out a large system than files full of
mystery and no hint as to what they're for.

And for me, I don't want a tome.  Those get TLDR from me.  Just a one liner saying what the file is.  I normally put longer descriptions, if necessary, later in the file after the header.


Reply via email to