<C#Learn/>
C#基礎 レッスン12

コメント

単一行・複数行・XMLドキュメントコメントの書き方を学びましょう。

コメントの種類

コメントはコンパイラに無視されるテキストで、コードの説明を書くために使います。 C#には3種類のコメントがあります。

// コメント— 単一行コメント。行末まで有効。
/* コメント */— 複数行コメント。開始と終了を明示。
/// XMLコメント— XMLドキュメントコメント。IDEのヒントやAPIドキュメント生成に使用。

単一行・複数行コメント

基本的なコメントの書き方を確認しましょう。

C#エディタ

XMLドキュメントコメント

/// で始まるコメントはXMLドキュメントコメントです。 メソッドやクラスの前に書くと、IDEのインテリセンス(補完機能)にドキュメントが表示されます。dotnet doc ツールでAPIドキュメントも生成できます。

XMLコメントの書き方

よく使うXMLタグを確認しましょう。

C#エディタ