XML 文档文件处理

项目
10/13/2023

编译器为代码（已标记以生成文档）中的每个构造生成一个 ID 字符串。有关详细信息，请参阅建议的文档注释标记。 ID 字符串唯一标识构造。处理 XML 文件的程序可以使用 ID 字符串来标识文档应用于的相应 .NET Framework 元数据或反射项。

XML 文件不是代码的分层表示形式；它是具有每个元素生成的 ID 的简单列表。

编译器在生成 ID 字符串时应遵循以下规则：

字符串不得包含空格。

ID 字符串的第一部分标识被标识的成员类型，单个字符后跟一个冒号。使用下面的成员类型：

字符	说明
N	命名空间无法将文档注释添加到命名空间中，但可能对命名空间进行 cref 引用。
T	类型：类、接口、结构、枚举、委托
日	Typedef
F	字段
P	属性（包括索引器或其他的索引属性）
M	方法（包括构造函数、运算符等特殊方法）
E	事件
"	错误字符串字符串的其余部分提供有关错误的信息。 MSVC 编译器将生成无法解析的链接的错误信息。

该字符串的第二部分是项目的完全限定名称，从命名空间的根开始。用句点分隔项目名称、其封闭类型和命名空间。如果项目名称本身包含句点，会将其替换为哈希符号 ('#')。假定没有名称中恰好包含哈希符号的项目。例如，String 构造函数的完全限定名称将是 System.String.#ctor。
对于属性和方法，如果方法带有自变量，则后跟用括号括起来的自变量列表。如果没有任何自变量，则不会出现括号。确保自变量之间用逗号分隔。每个参数的编码方式与其在 .NET Framework 签名中的编码方式相同：
- 基类型。常规类型（ELEMENT_TYPE_CLASS 或 ELEMENT_TYPE_VALUETYPE）表示为类型的完全限定名称。
- 内部类型（例如 ELEMENT_TYPE_I4、ELEMENT_TYPE_OBJECT、ELEMENT_TYPE_STRING、ELEMENT_TYPE_TYPEDBYREF 和 ELEMENT_TYPE_VOID）表示为相应完整类型的完全限定的名称，例如 System.Int32 或 System.TypedReference。
- ELEMENT_TYPE_PTR 表示为修改类型之后的“*”。
- ELEMENT_TYPE_BYREF 表示为修改类型之后的“@”。
- ELEMENT_TYPE_PINNED 表示为修改类型之后的“^”。 MSVC 编译器不会生成此元素。
- ELEMENT_TYPE_CMOD_REQ 表示为“|”和修饰符类的完全限定名称，前面是修改类型。 MSVC 编译器不会生成此元素。
- ELEMENT_TYPE_CMOD_OPT 表示为“!”和修饰符类的完全限定名称，前面是修改类型。
- ELEMENT_TYPE_SZARRAY 表示为“[]”，前面是数组的元素类型。
- ELEMENT_TYPE_GENERICARRAY 表示为“[?]”，前面是数组的元素类型。 MSVC 编译器不会生成此元素。
- ELEMENT_TYPE_ARRAY 表示为 [lower bound:size,lower bound:size]，其中逗号的数量是秩 - 1，每个维度的下限和大小（如果已知）以十进制形式表示。如果未指定下限或大小，则将其省略。如果省略了特定维度的下限和大小，则“:”也将被省略。例如，以 1 作为下限且未指定大小的二维数组表示为 [1:,1:]。
- ELEMENT_TYPE_FNPTR 表示为“=FUNC:type(signature)”，其中 type 是返回类型，signature 是方法的参数。如果没有任何自变量，则省略括号。 MSVC 编译器不会生成此元素。
不表示下列签名组件，因为它们永远不会用于区分重载方法：
- 调用约定
- 返回类型
- ELEMENT_TYPE_SENTINEL
仅针对转换运算符，该方法的返回值被编码为“~”，后面是返回类型，如上述编码所示。
对于泛型类型，类型名称后跟反勾号，然后是指示泛型类型参数数量的一个数字。例如，
```
<member name="T:MyClass`2">
```
该示例显示了定义为 public class MyClass<T, U> 的类型。

对于将泛型类型用作参数的方法，泛型类型参数被指定为前面加上反引号的数字（例如 `0 或 `1）。每个数字表示该类型的泛型参数的从零开始的数组位置。

示例

下面的示例演示如何为类及其成员生成 ID 字符串。

// xml_id_strings.cpp
// compile with: /clr /doc /LD
///
namespace N {
// "N:N"

   /// <see cref="System" />
   //  <see cref="N:System"/>
   ref class X {
   // "T:N.X"

   protected:
      ///
      !X(){}
      // "M:N.X.Finalize", destructor's representation in metadata

   public:
      ///
      X() {}
      // "M:N.X.#ctor"

      ///
      static X() {}
      // "M:N.X.#cctor"

      ///
      X(int i) {}
      // "M:N.X.#ctor(System.Int32)"

      ///
      ~X() {}
      // "M:N.X.Dispose", Dispose function representation in metadata

      ///
      System::String^ q;
      // "F:N.X.q"

      ///
      double PI;
      // "F:N.X.PI"

      ///
      int f() { return 1; }
      // "M:N.X.f"

      ///
      int bb(System::String ^ s, int % y, void * z) { return 1; }
      // "M:N.X.bb(System.String,System.Int32@,System.Void*)"

      ///
      int gg(array<short> ^ array1, array< int, 2 >^ IntArray) { return 0; }
      // "M:N.X.gg(System.Int16[], System.Int32[0:,0:])"

      ///
      static X^ operator+(X^ x, X^ xx) { return x; }
     // "M:N.X.op_Addition(N.X,N.X)"

      ///
      property int prop;
      // "M:N.X.prop"

      ///
      property int prop2 {
      // "P:N.X.prop2"

         ///
         int get() { return 0; }
         // M:N.X.get_prop2

         ///
         void set(int i) {}
         // M:N.X.set_prop2(System.Int32)
      }

      ///
      delegate void D(int i);
      // "T:N.X.D"

      ///
      event D ^ d;
      // "E:N.X.d"

      ///
      ref class Nested {};
      // "T:N.X.Nested"

      ///
      static explicit operator System::Int32 (X x) { return 1; }
      // "M:N.X.op_Explicit(N.X!System.Runtime.CompilerServices.IsByValue)~System.Int32"
   };
}

另请参阅

XML 文档

通过

XML 文档文件处理

示例

另请参阅

反馈

其他资源