半人前プログラマーの技術談議

開発した物と,C#を入門者向けに解説した記事を書いています!

【C# オブジェクト指向】ドキュメントコメント フォルダリング part2-☆1

calendar

reload

こんにちは!シロウです!

今回の記事は,補足partです.(☆が付いているpartは補足になります.)

ドキュメントコメント

ドキュメントコメントは,自分で作ったクラス,メソッドなどの説明をインテリセンスに表示させることができます.

通常のコメントは,「/(スラッシュ)」を2本使うか,「/*」と「*/」で囲んだ部分がコメントになりました.

 

ドキュメントコメントは,「/」を3本使って記述します.

 

ドキュメントコメントは,タグを組み合わせて記述します.

タグ 説明
summary クラスやメソッドの説明
param 引数の説明
returns 戻り値の説明
remarks 詳細
include 外部ファイルに書かれたドキュメントコメントを読み込む
value プロパティの説明
exception 例外処理の説明
example サンプルコードの説明 ※codeと組み合わせて使う
c コード
code 複数行のコード ※exampleと組み合わせて使う

他にもタグはありますが,よく使われるのが表で紹介したタグです.

特にsummary,param,returnsタグは頻繁に使われます.

 

実際に記述するとこんな感じです.

 

ソースコード

 

 

インテリセンスには,次のように表示されます.

 

フォルダリング

準備

始めに,上記のソースコードを2つ以上のソースファイル(クラス)に分離しましょう.

ソースファイルは1つのクラスごとに分けるのが調度いいです.

 

手順

① ソリューションエクスプローラーから,作成したプロジェクトを右クリックして,追加→新しい項目の順番にクリックする.

② Visual C#アイテムから,クラスを選択し,名前を入力後,追加をクリック.

③ Program.csファイルの,Programクラス以外のクラスのソースコードを,②で作成したファイルに書き写す.

 

ソリューションエクスプローラーで,以下の画像のようになっていることを確認できればOKです.

 

最初なので,2つのソースファイルのソースコードを貼っておきます.

 

Program.cs

 

 

Human.cs

 

 

試しに,この状態で実行してみたいと思います.

2つのソースファイルのnamespace(名前空間)同じ名前であることに注意してください.(違うとコンパイルエラーになります.)

 

実行結果

 

フォルダリング

フォルダリングは,複数のソースファイル,リソースファイルをフォルダにまとめることです.

今回は2つのソースファイルですが,規模が大きくなるとファイル数が多くなって,ソリューションエクスプローラーが見辛くなってきます.

操作性を上げる為に,フォルダリングでソースファイルをグループ化しましょう.

 

手順

① ソリューションエクスプローラーから,作成したプロジェクトを右クリックして,追加→新しいフォルダの順番にクリックする.

② 作成したフォルダに,ソースファイルをドラッグ&ドロップする.

これで,フォルダリングは完了です.

 

注意点

フォルダを作成した後でクラスを追加するときは,フォルダを右クリックして,先ほど紹介した手順でクラスを追加します.

その際に,作成したクラスのnamespace(名前空間)が「プロジェクト名.フォルダ名」になるので,使用する側のクラス(Program.csなど)から参照する時は,usingディレクティブでそのクラスのnamespaceを追加する必要があります.

 

 

今回はここまで!

次回の番外partは,オーバーロード,thisとbaseについて書くと思います.