diff options
| author | Corey Farwell <coreyf@rwell.org> | 2017-02-20 23:10:32 -0500 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2017-02-21 14:01:33 -0500 |
| commit | 94f3c1eee8a9aab2a3eb46af6c2bca6fd3b80101 (patch) | |
| tree | c6877d420c29c7ef6f9becd8b2ddbacae7491952 /src/doc/reference | |
| parent | 72497d5d139ed8ad382569a56425ca5f14ccb720 (diff) | |
| download | rust-94f3c1eee8a9aab2a3eb46af6c2bca6fd3b80101.tar.gz rust-94f3c1eee8a9aab2a3eb46af6c2bca6fd3b80101.zip | |
Comments
Diffstat (limited to 'src/doc/reference')
| -rw-r--r-- | src/doc/reference/src/comments.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/doc/reference/src/comments.md b/src/doc/reference/src/comments.md index bb8c8f793fc..784e19affd9 100644 --- a/src/doc/reference/src/comments.md +++ b/src/doc/reference/src/comments.md @@ -5,7 +5,7 @@ block (`/* ... */`) comment forms. Nested block comments are supported. Line comments beginning with exactly _three_ slashes (`///`), and block comments (`/** ... */`), are interpreted as a special syntax for `doc` -[attributes](#attributes). That is, they are equivalent to writing +[attributes]. That is, they are equivalent to writing `#[doc="..."]` around the body of the comment, i.e., `/// Foo` turns into `#[doc="Foo"]`. @@ -16,3 +16,5 @@ the body of the comment. `//!` comments are usually used to document modules that occupy a source file. Non-doc comments are interpreted as a form of whitespace. + +[attributes]: attributes.html |