I recall Google uses vertical bars in ObjC comments for similar purposes,
as stated in their style guide:
Use vertical bars to quote variable names and symbols in comments rather
than quotes or naming the symbol inline.
This helps eliminate ambiguity, especially when the symbol is a common word
that might make the sentence read like it was poorly constructed. E.g. for
a symbol "count":
// Sometimes we need |count| to be less than zero.
or when quoting something which already contains quotes
// Remember to call |StringWithoutSpaces("foo bar baz")|
--
https://google.github.io/styleguide/objcguide.xml?showone=Implementation_Comments#Implementation_Comments
пятница, 13 ноября 2015 г., 13:55:40 UTC+2 пользователь Colin Yates написал:
>
> Hi all,
>
> Can we, the community agree a consistent way of rendering Clojure EDN when
> we report it in info or error. For example, given the EDN "2" (i.e. a
> string containing a single character 2) I have seen various libraries
> render it as:
>
> - 2
> - "2"
> - ["2"]
> - [2]
> - (2)
> - '"2"'
>
> I would like to propose that we standardise around "_" as the boundary
> character as that isn't likely to be used in (except for some markup I
> guess but that is pretty unlikely), so a test framework might render as
> such:
>
> - expected _2_ but was _"2"_
>
> Please? :-)
>
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
---
You received this message because you are subscribed to the Google Groups
"Clojure" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
