c++ style `argument` vs |argument|

[Luciano Pacheco]

Hi all,

In Chromium repo we usually use the style |argument| when referring to a argument in comment/documentation however in Google C++ style guide it says to use `backtick_argument`:

https://google.github.io/styleguide/cppguide.html#Function_Comments

"What the inputs and outputs are. If function argument names are provided in `backticks`, then code-indexing tools may be able to present the documentation better."

I recall reading somewhere about our specific style (|argument_name| and functionName()), but I can't find it anymore.

Is |argument_name| really the recommended style?

Is our specific style documented somewhere or do we just go with cargo cult?

Cheers,

Luciano Pacheco

[Honglin Yu]

` should also be preferred in chromium now: https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++-dos-and-donts.md#comment-style

--
You received this message because you are subscribed to the Google Groups "cxx" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cxx+uns...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CACqyNVDdkmYZh9YLD%3D2k5v8fNvfc7dyupmAKO4B5JcNiyi_e2w%40mail.gmail.com.

[Luciano Pacheco]

Perfect! Thanks for the clarification and link.

Yeah, I had missed that we switched styles for this. :-)

[Honglin Yu]

No problem! This should have been changed very recently.