<paramref> ドキュメント タグ

<paramref> タグは、単語がパラメーターであることを示す方法を提供します。 XML ファイルを処理することで、いくつかの独自の方法でこのパラメーターの書式設定を行うことができます。

構文

/// <paramref name="ref-name"/>

パラメーター

ref-name
参照されるパラメーターの名前です。 名前は、一重引用符または二重引用符で囲みます。 コンパイラでは、ref-name が見つからない場合に警告を発行します。

解説

コンパイル時に /doc を指定して、ドキュメント コメントをファイルに出力します。

// xml_paramref_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_paramref_tag.dll
/// Text for class MyClass.
public ref class MyClass {
   /// <summary>MyMethod is a method in the MyClass class.
   /// The <paramref name="Int1"/> parameter takes a number.
   /// </summary>
   void MyMethod(int Int1) {}
};

関連項目

XML ドキュメント