The usual pattern for both Doxygen comments and Git commit messages, is that the first line is a one-line "headline" summary, with no full stop, and then if any more detail is needed there's a blank line followed by a paragraph of real sentences with full stops.
Okay, okay, that's starting to make sense. You don't put periods at the end of a headline. That, that right there, is indeed an actual English rule that I can understand. If we were extracting out to dox, then that would mean something.
However, that's not what our coding standard says. Our coding standard just says "inline comments, no period. Tripleslash comments at the tops of methods and classes, put the period."
I wonder if the coding standard here came from something like that, but then the real details got diluted, and when it finally got typed into our coding standards, the original meaning was lost? Sort of like an
E Plebneesta of coding standards?
Previous Topic
Index
