Skip to content

Commit 10542da

Browse files
authored
Update Javaコーディング規約.md
1 parent feb35ff commit 10542da

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

documents/forJava/Javaコーディング規約.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1605,7 +1605,7 @@ head:
16051605
## ラムダ式・メソッド参照・コンストラクタ参照
16061606

16071607
- ラムダ式が利用できる箇所はラムダ式を利用してよい
1608-
[※パフォーマンスについても記載しているので参考にしてください](#ラムダ式・メソッド参照・コンストラクタ参照-2)
1608+
[※パフォーマンスについても記載しているので参考にしてください](#ラムダ式・メソッド参照・コンストラクタ参照-1)
16091609
- ただし、メソッド参照・コンストラクタ参照が利用できる場合はメソッド参照・コンストラクタ参照を利用する
16101610

16111611
良い例:
@@ -2355,7 +2355,7 @@ head:
23552355
(Eclipse の TODO コメント形式を採用)
23562356
例)
23572357
2358-
```
2358+
```java
23592359
//TODO:ワークフローの仕様決定待ち 関連チケット#12345
23602360
```
23612361
@@ -2365,8 +2365,8 @@ Java では 3 種類のコメントが使える。javadoc コメントは`/**`
23652365
23662366
| コメント種類 | 使用方法 | 例 |
23672367
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2368-
| javadoc コメント<br>`/** comment */` | interface、class、メソッド、フィールドの直前に書く。コメントは javadoc によって処理され、外部ドキュメント(HTML)として生成される。(この形式以外のコメントはドキュメントとして出力されないことに注意) | <code class="comment-code">/\*_<br> _ 顧客(Customer)-<br> _ 顧客はわれわれがサービスまたは製品を売った人物<br> _ もしくは組織のいずれかである。<br> _ @author 開発太郎<br> _/</code> |
2369-
| C 風コメント<br>`/* comment */` | 特定のコードを無効化したいが、後で使用するかもしれないので残しておくためにコメント化する時や、デバッグ時に一時的に無効化するときに使用する。 | <code class="comment-code">/_ <br> このコードは J.T.Kirk によって 1997.12.9 に前述のコードと置き換えたためコメント化した。2 年間不要であるならば削除せよ。<br> ... (ソースコード) <br> _/</code> |
2368+
| javadoc コメント<br>`/** comment */` | interface、class、メソッド、フィールドの直前に書く。コメントは javadoc によって処理され、外部ドキュメント(HTML)として生成される。(この形式以外のコメントはドキュメントとして出力されないことに注意) | <code class="comment-code">/\*\*<br> \* 顧客(Customer)-<br> \* 顧客はわれわれがサービスまたは製品を売った人物<br> \* もしくは組織のいずれかである。<br> \* @author 開発太郎<br> \*/</code> |
2369+
| C 風コメント<br>`/* comment */` | 特定のコードを無効化したいが、後で使用するかもしれないので残しておくためにコメント化する時や、デバッグ時に一時的に無効化するときに使用する。 | <code class="comment-code">/\*<br> このコードは J.T.Kirk によって 1997.12.9 に前述のコードと置き換えたためコメント化した。2 年間不要であるならば削除せよ。<br> ... (ソースコード) <br>\*/</code> |
23702370
| 単一行コメント<br>`// comment` | メソッド内にて、ビジネスロジック、コードの概要、一時変数の定義内容などを記述する。 | <code class="comment-code">// 1995 年 2 月に開始された X 氏の寛大なキャンペーンで<br>// 定められた通り 1000$を超える請求には、全て 5%割引を<br>// 適用する。</code> |
23712371
23722372
※ ロジック中に、頻繁に C 風コメントでコメントを書くとまとめてコメントアウトする場合に不便なため、基本的にロジック中では単一行コメントを利用すること。

0 commit comments

Comments
 (0)