<preliminary> 标记将类型/成员标记为“预发布”。

<preliminary>[description]</preliminary>

其中:

description

对“预发布”的说明文本。(可选)

应用于

所有的类型及成员。

备注

若没有指定 description，则以红色显示默认的文本: “[此文档为预发布版本，在未来版本中有可能改变。]”

如果需要把全部类型/成员都标记为“预发布”，请使用文档引擎的 Preliminary 配置项。

示例

[C#]
// The class summary will get the default message
/// <preliminary/>
public class MyClass
{
   /// <preliminary>
   /// <para>This method is just for testing right now. It might be removed in the near future</para>
   /// </preliminary>
   public void Dump ()
   {
   }
}

请参见

标记用法 | NDoc 支持的标记