We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 19f1c31 commit 58807b0Copy full SHA for 58807b0
doc/rust.md
@@ -163,7 +163,13 @@ line_comment : "//" non_eol * ;
163
164
Comments in Rust code follow the general C++ style of line and block-comment forms,
165
with no nesting of block-comment delimiters.
166
-Comments are interpreted as a form of whitespace.
+
167
+Line comments beginning with _three_ slashes (`///`),
168
+and block comments beginning with a repeated asterisk in the block-open sequence (`/**`),
169
+are interpreted as a special syntax for `doc` [attributes](#attributes).
170
+That is, they are equivalent to writing `#[doc "..."]` around the comment's text.
171
172
+Non-doc comments are interpreted as a form of whitespace.
173
174
## Whitespace
175
0 commit comments