Skip to content

Commit

Permalink
Add review changes
Browse files Browse the repository at this point in the history
  • Loading branch information
traviscross committed Sep 24, 2024
1 parent 9a2836e commit cc29656
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/comments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Comments

r[comments.lexical]
r[comments.syntax]

> **<sup>Lexer</sup>**\
> LINE_COMMENT :\
Expand Down Expand Up @@ -53,7 +53,7 @@ Line doc comments beginning with exactly _three_ slashes (`///`), and block
doc comments (`/** ... */`), both outer doc comments, are interpreted as a
special syntax for [`doc` attributes].

r[comments.doc.attribute]
r[comments.doc.attributes]
That is, they are equivalent to writing
`#[doc="..."]` around the body of the comment, i.e., `/// Foo` turns into
`#[doc="Foo"]` and `/** Bar */` turns into `#[doc="Bar"]`.
Expand All @@ -63,12 +63,12 @@ Line comments beginning with `//!` and block comments `/*! ... */` are
doc comments that apply to the parent of the comment, rather than the item
that follows.

r[comments.doc.inner-attribute]
r[comments.doc.inner-attributes]
That is, they are equivalent to writing `#![doc="..."]` around
the body of the comment. `//!` comments are usually used to document
modules that occupy a source file.

r[comments.doc.bare-cr]
r[comments.doc.bare-crs]
The character `U+000D` (CR) is not allowed in doc comments.

> **Note**: The sequence `U+000D` (CR) immediately followed by `U+000A` (LF) would have been previously transformed into a single `U+000A` (LF).
Expand Down

0 comments on commit cc29656

Please sign in to comment.