Hey folks!
I wanted to bring up a style issue that I noticed recently. In some
comments in the codebase, backticks are used to quote code excerpts and
object names, while in other comments, single quotes are used. This doesn't
seem to be documented in our style guide (nor in Google's), and I think it
would be a good idea to establish a policy on this and document it, so that
we can avoid wasted review cycles related to this in the future.

It's likely that the backtick convention began because Doxygen will render
backtick-enclosed text in monospace, and for this reason I would propose
that we consistently use backticks to quote code excerpts and object names
in comments from now on. What does everyone else think?

Cheers,
Greg

Reply via email to