大量のソースコードを読んでたりすると、このコードのクラスや関数、変数って何を表しているのか?
ということがあると思います。
そんなときにはドキュメントコメントを書くと内容を把握しやすくなり、コードの可読性が上がります。
今回はC#でのドキュメントコメントの書き方について紹介していきたいと思います。
ドキュメントコメントとは?
ドキュメントコメントとはクラスや関数、変数の説明を表示させるコメントのことを指します。
ドキュメントコメントとしてコメントを書くと、カーソルを合わせた時にその変数や関数が何かを
表示してくれるようになります。
[カーソルを合わせると説明が出てくるようになる]
ではここからVisual StudioでC#でのドキュメントコメントの書き方を紹介していきたいと思います。
関数や変数の前で///を書く
Visual Studioでドキュメントコメントを付けたいクラスや関数、変数の前で
///と書きます。
すると自動で<summary>というタグが出てきます。
この<summary>と<summary>の間に説明を書くとカーソルを合したときに説明が出てくるようになります。
/// <summary>
/// ここに説明を書く
/// <summary>
ちなみにドキュメントコメントを書いておくと、
別クラスでその関数なども扱うときに説明が出てくるようになります。
別の参照されている箇所でもカーソルを合わせると説明が出てくれました。
引数の説明を表示させる
引数がある関数の前で///を入力すると、以下のようになります。
引数なしの関数と異なり、新たに<param>というタグが出てきました。
/// <param name="第一引数">説明内容したい内容</param>
/// <param name="第二引数">説明内容したい内容</param><param name = “”>の””には引数が入ります。引数がある関数の前で///を記述すると
<param name = “”>の””に自動的に引数を入力してくれます。
あとは<pram name = “”>と</param>の間に説明したい内容を書くとカーソルを合わしたときに
引数の説明が出るようになります。
引数にカーソルを合わせると説明が出てくれました。
おわりに
いかがだったでしょうか。
開発をしている時に膨大なコードを読んでいて、この関数は何を意味しているのだろう？
と思うこともよくあるのですが、今回紹介したドキュメントコメントを上手く活用していただければ、
コードの可読性も上がり、処理の流れを追いやすくなると思います。
ドキュメントコメントを活用して日々の開発に役立てもらえたらなと思います。
ではでは！
コメント