@@ -83,29 +83,32 @@ that does _not_ occur in the set of [keywords](#keywords).
83
83
84
84
## Comments
85
85
86
- Comments in Rust code follow the general C++ style of line and block-comment
87
- forms. Nested block comments are supported.
86
+ Comments in Rust code follow the general C++ style of line ( ` // ` ) and
87
+ block-comment ( ` /* ... */ ` ) forms. Nested block comments are supported.
88
88
89
89
Line comments beginning with exactly _ three_ slashes (` /// ` ), and block
90
90
comments beginning with exactly one repeated asterisk in the block-open
91
91
sequence (` /** ` ), are interpreted as a special syntax for ` doc `
92
92
[ attributes] ( #attributes ) . That is, they are equivalent to writing
93
- ` #[doc="..."] ` around the body of the comment (this includes the comment
94
- characters themselves, i.e. ` /// Foo ` turns into ` #[doc="/// Foo"] ` ) .
93
+ ` #[doc="..."] ` around the body of the comment, i.e., ` /// Foo ` turns into
94
+ ` #[doc="Foo"] ` .
95
95
96
96
Line comments beginning with ` //! ` and block comments beginning with ` /*! ` are
97
97
doc comments that apply to the parent of the comment, rather than the item
98
98
that follows. That is, they are equivalent to writing ` #![doc="..."] ` around
99
- the body of the comment. ` //! ` comments are usually used to display
100
- information on the crate index page .
99
+ the body of the comment. ` //! ` comments are usually used to document
100
+ modules that occupy a source file .
101
101
102
102
Non-doc comments are interpreted as a form of whitespace.
103
103
104
104
## Whitespace
105
105
106
- The ` whitespace_char ` production is any nonempty Unicode string consisting of
107
- any of the following Unicode characters: ` U+0020 ` (space, ` ' ' ` ), ` U+0009 `
108
- (tab, ` '\t' ` ), ` U+000A ` (LF, ` '\n' ` ), ` U+000D ` (CR, ` '\r' ` ).
106
+ Whitespace is any non-empty string containing any the following characters:
107
+
108
+ - ` U+0020 ` (space, ` ' ' ` )
109
+ - ` U+0009 ` (tab, ` '\t' ` )
110
+ - ` U+000A ` (LF, ` '\n' ` )
111
+ - ` U+000D ` (CR, ` '\r' ` )
109
112
110
113
Rust is a "free-form" language, meaning that all forms of whitespace serve only
111
114
to separate _ tokens_ in the grammar, and have no semantic significance.
0 commit comments