Reviewers should always require appropriate in-code documentation. That said, I don't think the style guide is the appropriate place to solve this problem.
On Thu, Jan 21, 2016 at 10:42 AM, R Kent James <k...@caspia.com> wrote: > As someone who spends a lot of time trying to understand code that I know > nothing about, I find it very frustrating that Mozilla code frequently is > written with absolutely no comment on why that code exists, or what it is > trying to do. > > Today's example: SharedCertVerifier.h > > Inquiring minds want to know - why does this file exist, and what is it > roughly supposed to do (since it seems to be resulting in a build failure > in comm-central). It seems to just extend CertVerifier, but why? I suppose > it has something to do with sharing the certificates from the name, but > whoever wrote it originally probably has some idea why. > > A simple policy like "Classes should have at least a one sentence comment > describing their purpose" would go a long way to helping those of us who > encounter them. > > :rkent > _______________________________________________ > dev-platform mailing list > dev-platform@lists.mozilla.org > https://lists.mozilla.org/listinfo/dev-platform > _______________________________________________ dev-platform mailing list dev-platform@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-platform
