+1. Additional note is that this is now the de facto syntax for code snippets on the rest of our tools, too, including RB and JIRA.
On Mon, Nov 2, 2015 at 10:32 AM, Greg Mann <[email protected]> wrote: > 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 -- Alex Theory is the first term in the Taylor series of practice. -- Thomas M Cover (1992)
