Guide: comments #15374
Merged
Guide: comments #15374
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| return | ||
| Now that we have some functions, it's a good idea to learn about comments. | ||
| Comments are notes that you leave to other programmers to help explain things | ||
| about your code. The compiler ignores them. |
There was a problem hiding this comment.
It doesn't ignore doc comments entirely...
There was a problem hiding this comment.
(e.g. it can and will complain about
fn foo() {
let a = 0u;
/// descriptive comment
let b = 1u;
}because doc comments can only be attached to items.)
There was a problem hiding this comment.
That's fair. Do you think this is too detailed a point to put into an introduction?
There was a problem hiding this comment.
"the compiler mostly ignores them"?
|
Added in the 'mostly. |
bors
added a commit
that referenced
this pull request
Jul 9, 2014
I'm leaving off `rustdoc` usage because it won't work unless this is a `pub fn`, and I want to talk about public/private in the context of modules. I'm also not mentioning `//!` because it is exclusively used to provide the overview of a module.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
I'm leaving off
rustdocusage because it won't work unless this is apub fn, and I want to talk about public/private in the context of modules. I'm also not mentioning//!because it is exclusively used to provide the overview of a module.