スポンサーリンク
プログラミングする際に、読みやすいコードを書くことは非常に重要ですよね。
そして、読みやすさをさらに高めてくれるのがコメントです。
コメントが有る無しで読みやすさがかなり変わってくるので、どんなコメントがあるか学んでおきましょう！
今回も私ブレインキャットがお供します。
どんな種類があるのか
以下のコメントは多く使われます。
それぞれどんなときにに使われるか理解しておきましょう！
- summary
- param
- return
- remarks
summary
summaryとは日本語で「概要」という意味です。
クラスやメソッドの説明に使います。
1 2 3 4 5 6 7 | /// <summary> /// テスト処理 /// </summary> private void Test() { } |
param
メソッドの引数があるときの説明に使います。
1 2 3 4 5 6 7 8 9 | /// <summary> /// テスト処理 /// </summary> /// <param name="age">年齢</param> /// <param name="name">名前</param> private void Test(int age, string name) { } |
return
戻り値がある場合なんかに使います。
1 2 3 4 5 6 7 8 9 | /// <summary> /// 為替計算処理 /// </summary> /// <param name="dollar">ドル</param> /// <returns>円</returns> private decimal Sum(decimal dollar) { return dollar * 110; } |
remarks
remarksとは日本語で「備考」という意味ですね。
備考などを書いておく際に使います。
1 2 3 4 5 6 7 8 9 10 | /// <summary> /// 為替計算処理 /// </summary> /// <param name="dollar">ドル</param> /// <returns>円</returns> /// <remarks>ドルから円を算出して返却する</remarks> private decimal Sum(decimal dollar) { return dollar * 110; } |
まとめ
今回は非常によく使うものについてかいていきました。
コメントについては、後で他の人が見てもわかりやすいことを意識して書きましょう！
スポンサーリンク
