はじめに
タイトルにもあります通り、この記事では、XMLタグの活用方法について書いています!
この記事を書いた背景
現在私は、C#を使ったメタバースを開発を行なっているのですが、後から読んでも分かりやすいように、コーディングの際にXMLタグをよく使っていました。そしたら、プルリク時に「読みやすくていいコードだ」とCTOに褒められたので、どこで、どのように記述するかをまとめてみました。
※XMLタグをコメントとして使える言語は調べた限りC#でしか使えませんでした
XMLとは？
XML (eXtensible Markup Language) は、データを記述するための標準的なマークアップ言語です。XML は HTML と似ていますが、HTML は特定の目的のために設計されているのに対して、XML は柔軟性を重視して設計されており、様々な種類のデータを扱うことができます。XML は、そのデータを記述するためのタグを自由に定義することができるので、XML ファイルにはそのデータに特化したタグが用いられます。
用意されているタグ
| タグ名 | 内容 |
|---|---|
| summary | 型また型のメンバの概要 |
| remarks | 追記(追加情報) |
| value | プロパティ値説明 |
| para | 記タグ内で段落作成が可能 summary・remarks・returns |
| param | メソッドパラメータ、型自動判定 |
| typeparam | ジェネリック型[^1]パラメータ、型自動判定 |
| paramref | インラインのパラメータ参照 |
| typeparamref | ジェネリック型[^1]パラメータ参照 |
| returns | 戻り値 |
| exception | 例外 |
よく使うタグの使い方サンプル(C#での記述)
<summary>の記述例
<summary>は関数に対して、コメントをつけることができます！すでに戻り値のある関数の１行上に開始の合図である"///"を入力すると、自動的にsummaryが生成されます！
<return>の記述例
<return>は関数の戻り値に対して、コメントをつけることができます！すでに戻り値のある関数の１行上に開始の合図である"///"を入力すると、自動的にsummaryとreturnタグが生成されます！
<param>の記述例
<param>は関数の引数に対して、コメントをつけることができます！すでにある引数のある関数の１行上に開始の合図である"///"を入力すると、自動的にsummaryとparamタグが生成されます！
XMLタグのコメントは、引数にマウスをホバーすると参照できます！
参考
公式ドキュメント
まとめ
コメントで使うXMLタグを使用していると、コーディング時のルールとして追加しても良いくらい、C#開発者には使用してほしいものです。しかし、XMLタグが使用されているかどうかは、マウスホバーでしか確認することができないため、拡張機能で関数に下線を引くなどがあればもっと使いやすくなると思いました！
ここまで読んでいただき、ありがとうございました！