初心者必見!C#のコメント・ドキュメントコメントまとめ

初心者必見!覚えておこう コメントの使い方

C#のコメントってなに? 動作に影響は?

コメントを入れ方ってどうするの?

ドキュメントコメントって何?

こんにちは、エンジニアでC#ライターの遠藤です。

プログラミング言語を学習していて、早いうちに覚えた方が良いものにコメントがあります。

コメントがないと、プロジェクトの規模が大きくなったときにとても困ります。またプロジェクトの規模に関わらず、デバッグするときに頻繁に使われます。

今回の記事では、そんなC#のコメントについて解説します!

この記事はこんな方に向けて書きました。

  • コメントについて知らない方
  • コメントについては分かるが、やり方を知らない方
  • ドキュメントコメントについて知らない方

この記事を読んでいただければ、コメント・ドキュメントコメントについて理解することができます

ぜひ最後までお付き合いください。

コメントとは

まずはじめに、ここで言うコメントとは、プログラム中に含まれる処理には含まれないメッセージの事です。

コメントを入れる事によって複雑な処理の概要を説明したり、なぜこの処理が入っているかを書き込んだりすることができます。

なお、コメントは実際の動作に影響を与えないので自由に書き込むことが可能です。

実際の例を見てみましょう。

このように「//」を使うと、//以降の文字がコメントとして扱われます。

なお、//はその行のみで有効です。複数行コメントをつけたい場合は「/* 複数行コメント */」のように記述する事ができます。

例:

コメントはその処理の概要だったり、どういう意図で実装したかをメモとして残すときに活用します。

コメントアウトとは

コードディングをしていくうえで、コメントアウトは頻繁に使います。

コメントアウトはメッセージをコメントとして残すのではなく、コードをコメントの中に入れる事によってその行の処理を実行させないことを言います。

実行結果:

一つ目のWriteLine出力がされませんでした。

コメントアウトの利用目的は、以下のようなケースがあります。

  • 実行しなかった場合の処理の差分を確認する場合
  • 今は不要な処理だが今後必要になる可能性がある場合、保持のため

ドキュメントコメントとは

C#ではドキュメントコメントと言う、クラスやメソッドの概要、引数の内容などをXML形式で記述するタイプのコメントがあります。

ドキュメントコメントは設計のさいにも便利ですし、クラスやメソッドの概要や目的が一目で分かるのでメンテナンスしやすくなります。また、設定によってXMLファイルに出力することも可能です。

書き方は後にまとめますので、先に実際の例を見てみましょう。

上記のように、メソッドの上に「///」で書かれているのがドキュメントコメントです。

また、これをXMLファイルに出力すると以下のように表示されます。

XMLファイルへの出力は、使用するIDE(開発環境)によって変わります。ご自身の環境の手順で試してみてください。

ドキュメントコメントの書きかた

ここでは、ドキュメントコメントの書きかたを簡単にまとめます。

まず、「///」でドキュメントコメントにする事は上述のとおりです。また、複数行をまとめてドキュメントコメントとする場合は「/** 複数行コメント */」で記述することができます。

タグ一覧

ドキュメントコメントはXML形式で記述します。使用するタグ一覧は以下になります。

タグ名意味備考
summaryクラスやメソッドの概要を説明する
remarksメンバーの説明をするsummaryで指定された情報を補足する
returns戻り値を説明する
cテキストをコードとして扱うsummary内などで使う
code複数行のコードを記述する
exampleコード例を記述する(主にcodeを使う)
*exception例外について説明する

*include
別のファイル内のコメントを取り込む
paraテキストに構造を追加する(段落)summary内などで使う
*paramそのメソッドのパラメータ(引数)について説明する
paramrefsummaryなどの中でパラメータ(引数)を参照するさいに使う
*typeparamパラメータの型などを説明する
typeparamrefsummaryなどの中で型パラメータを参照するさいにつかう
valueプロパティについて説明する
listリスト・テーブルを説明する
*permissionメンバーへのアクセスのパーミッションを記述する
*see他のメンバやフィールドを参照するさいに使う
*seealsoseeの他に参照が必要なものを記述する

なお、「*」のついているタグはコンパイラのチェックが入ります。

まとめ

今回の記事では、

  • コメントについて
  • コメントアウトについて
  • ドキュメントコメントについて

を解説致しました。

また、ここで紹介したコメント・ドキュメントコメントの主な用途は以下の通りです。

  • 複雑な処理の概要を説明
  • なぜこの処理が入っているかの説明
  • クラスやメソッドの概要を説明
  • 引数の内容などを記載

コメントはコードの規模が大きくなるほど重要になってきます。ここで使い方を覚えて、スマートな設計を心掛けてください!

LINEで送る
Pocket

最短でエンジニアを目指すなら侍エンジニア塾

cta_under_bnr

侍エンジニア塾は業界で初めてマンツーマンレッスンを始めたプログラミングスクールです。これまでの指導実績は16,000名を超え、未経験から数多くのエンジニアを輩出しています。

あなたの目的に合わせてカリキュラムを作成し、現役エンジニア講師が専属であなたの学習をサポートするため効率よく学習を進めることができますよ。

無理な勧誘などは一切ありません。まずは無料体験レッスンを受講ください。

無料体験レッスンの詳細はこちら

書いた人

遠藤貴大

遠藤貴大

1991年生まれ。双子座。
理系大学で認証システムを学んだ後、アプリ開発者となる。
新しく学ぶ人に寄り添った記事を心がけて執筆します。
芸術が好き。いつか猫と暮らすのが夢。

おすすめコンテンツ

あなたにぴったりなプログラミング学習プランを無料で診断!

プログラミング学習の効率を劇的に上げる学習メソッドを解説