1
- % Comments
1
+ % コメント
2
+ <!-- % Comments -->
2
3
3
- Now that we have some functions, it’s a good idea to learn about comments.
4
- Comments are notes that you leave to other programmers to help explain things
5
- about your code. The compiler mostly ignores them.
4
+ <!-- Now that we have some functions, it’s a good idea to learn about comments. -->
5
+ <!-- Comments are notes that you leave to other programmers to help explain things -->
6
+ <!-- about your code. The compiler mostly ignores them. -->
7
+ いくつかの関数ができたので、コメントについて学ぶことはよい考えです。
8
+ コメントはコードについての何かを説明する助けになるように、他のプログラマに残すメモです。
9
+ コンパイラはそれらをほとんど無視します。
6
10
7
- Rust has two kinds of comments that you should care about: * line comments*
8
- and * doc comments* .
11
+ <!-- Rust has two kinds of comments that you should care about: *line comments* -->
12
+ <!-- and *doc comments*. -->
13
+ Rustには気にすべき2種類のコメント、 * 行コメント* と * ドキュメンテーションコメント* があります。
9
14
10
15
``` rust
11
- // Line comments are anything after ‘//’ and extend to the end of the line.
16
+ # // Line comments are anything after ‘//’ and extend to the end of the line.
17
+ // 行コメントは「//」以降の全ての文字であり、行末まで続く
12
18
13
19
let x = 5 ; // this is also a line comment.
14
20
15
- // If you have a long explanation for something, you can put line comments next
16
- // to each other. Put a space between the // and your comment so that it’s
17
- // more readable.
21
+ # // If you have a long explanation for something, you can put line comments next
22
+ # // to each other. Put a space between the // and your comment so that it’s
23
+ # // more readable.
24
+ // もし何かのために長い説明を書くのであれば、行コメントを複数行に渡って書くこと
25
+ // ができる。//とコメントとの間にスペースを置くことで、より読みやすくなる
18
26
```
19
27
20
- The other kind of comment is a doc comment. Doc comments use ` /// ` instead of
21
- ` // ` , and support Markdown notation inside:
28
+ <!-- The other kind of comment is a doc comment. Doc comments use `///` instead of -->
29
+ <!-- `//`, and support Markdown notation inside: -->
30
+ その他の種類のコメントはドキュメンテーションコメントです。
31
+ ドキュメンテーションコメントは` // ` の代わりに` /// ` を使い、その中でMarkdown記法をサポートします。
22
32
23
33
``` rust
24
- /// Adds one to the number given.
34
+ # /// Adds one to the number given.
35
+ /// 与えられた数値に1を加える
25
36
///
26
37
/// # Examples
27
38
///
@@ -38,22 +49,30 @@ fn add_one(x: i32) -> i32 {
38
49
}
39
50
```
40
51
41
- There is another style of doc comment, ` //! ` , to comment containing items (e.g.
42
- crates, modules or functions), instead of the items following it. Commonly used
43
- inside crates root (lib.rs) or modules root (mod.rs):
52
+ <!-- There is another style of doc comment, `//!`, to comment containing items (e.g. -->
53
+ <!-- crates, modules or functions), instead of the items following it. Commonly used -->
54
+ <!-- inside crates root (lib.rs) or modules root (mod.rs): -->
55
+ もう1つのスタイルのドキュメンテーションコメントに` //! ` があります。これは、その後に続く要素ではなく、それを含んでいる要素(例えばクレート、モジュール、関数)にコメントを付けます。
56
+ 一般的にはクレートルート(lib.rs)やモジュールルート(mod.rs)の中で使われます。
44
57
45
58
```
46
- //! # The Rust Standard Library
59
+ //! # Rust標準ライブラリ
47
60
//!
48
- //! The Rust Standard Library provides the essential runtime
49
- //! functionality for building portable Rust software.
61
+ //! Rust標準ライブラリはポータブルなRustソフトウェアをビルドするために不可欠な
62
+ //! ランタイム関数を提供する。
50
63
```
51
64
52
- When writing doc comments, providing some examples of usage is very, very
53
- helpful. You’ll notice we’ve used a new macro here: ` assert_eq! ` . This compares
54
- two values, and ` panic! ` s if they’re not equal to each other. It’s very helpful
55
- in documentation. There’s another macro, ` assert! ` , which ` panic! ` s if the
56
- value passed to it is ` false ` .
65
+ <!-- When writing doc comments, providing some examples of usage is very, very -->
66
+ <!-- helpful. You’ll notice we’ve used a new macro here: `assert_eq!`. This compares -->
67
+ <!-- two values, and `panic!`s if they’re not equal to each other. It’s very helpful -->
68
+ <!-- in documentation. There’s another macro, `assert!`, which `panic!`s if the -->
69
+ <!-- value passed to it is `false`. -->
70
+ ドキュメンテーションコメントを書いているとき、いくつかの使い方の例を提供することは非常に非常に有用です。
71
+ ここでは新しいマクロ、` assert_eq! ` を使っていることに気付くでしょう。
72
+ これは2つの値を比較し、もしそれらが互いに等しくなければ` panic! ` します。
73
+ これはドキュメントの中で非常に便利です。
74
+ もう1つのマクロ、` assert! ` は、それに渡された値が` false ` であれば` panic! ` します。
57
75
58
- You can use the [ ` rustdoc ` ] ( documentation.html ) tool to generate HTML documentation
59
- from these doc comments, and also to run the code examples as tests!
76
+ <!-- You can use the [`rustdoc`](documentation.html) tool to generate HTML documentation -->
77
+ <!-- from these doc comments, and also to run the code examples as tests! -->
78
+ それらのドキュメンテーションコメントからHTMLドキュメントを生成するため、そしてコード例をテストとして実行するためにも[ ` rustdoc ` ] ( documentation.html ) ツールを使うことができます!
0 commit comments