nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-02-26 05:44:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mention doc comments.

Browse Source
This commit is contained in:
Graydon Hoare 2012-10-10 16:51:11 -07:00
parent 19f1c3174f
commit 58807b0500
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/rust.md
View File

@ -163,7 +163,13 @@ line_comment : "//" non_eol * ;
Comments in Rust code follow the general C++ style of line and block-comment forms,
with no nesting of block-comment delimiters.
Comments are interpreted as a form of whitespace.
Line comments beginning with _three_ slashes (`///`),
and block comments beginning with a repeated asterisk in the block-open sequence (`/**`),
are interpreted as a special syntax for `doc` [attributes](#attributes).
That is, they are equivalent to writing `#[doc "..."]` around the comment's text.
Non-doc comments are interpreted as a form of whitespace.
## Whitespace