close

Template:dcl end

来自cppreference.com
[编辑] [{{purge}}] 模板文档

这是用于创建声明列表的模板系列之一。

列表模板系列

  • dsc ****：用于创建成员变量/函数列表。
  • dcl ****：用于创建详细声明列表（包含实际声明代码）。
  • sdsc ****：用于创建表示语言功能特性的多种语法的列表。在 cpp/language 的子页面中使用。
  • par ****：用于创建解释函数参数的列表。
  • spar ****：用于创建解释语法参数的列表。
  • nv ****：用于创建导航栏中的特性列表。
  • elink **** : 用于创建外部连接 列表。

{{dcl begin}}

开始声明列表

{{dcl end}}

结束声明列表。此模板自动在项目上添加 {{dcl sep}}。

{{dcl rev begin|num=编号 (可选)}}

开始带版本声明列表。
  • num (可选) 可用于编号目的（覆写用于版本列表（即直至 {{dcl rev end}}）中的 {{dcl}} 模板的编号 参数）。

{{dcl rev end}}

结束带版本声明列表。

{{dcl header|标头 }}

添加功能特性来源的标头的解释。

{{dcl sep}}

添加分隔符。

{{dcl h|小标题 }}

添加小标题。适用于分割并描述大组的相关声明。

{{dcl|声明 |notes=注解 (可选)|num=编号 (可选)|since=起始标准 (可选)|until=截止标准 (可选)|deprecated=弃用标准 (可选)|removed=移除标准 (可选)}}

添加项目到声明列表。此模板自动在项目上添加 {{dcl sep}}。
  • 声明 是功能特性的声明。
  • notes (可选) 可用于添加对功能特性的注解。
  • num (可选) 可用于编号目的。
  • since (可选) 指定定义出现的首个标准。
  • until (可选) 指定不包含此定义的首个标准。
  • deprecated (可选) 要么指定此定义被弃用的首个标准，要么等于 yes，此情况下它指示该定义始终为弃用。
  • removed (可选) 能以两种方式之一使用：
    • 指定了 until 时，它指定“X 前”标签是否应以“X 中移除”替代，可为 yes 或 no。
    • 若缺失，则若指定了 deprecated 则默认为 yes，否则为 no。
    • 未指定 until 时，removed=x 等价于 until=x|removed=yes。

{{dcla| 的参数 |anchor=锚点名|no (可选)|noexcept=noexcept 标准 (可选)|constexpr=constexpr 标准 (可选)|expos=yes (可选)}}

与 {{dcl}} 相同，带有扩充的参数集，并额外增加了可以生成内部 HTML 锚点的能力。
  • anchor (可选)
    • 如果指定了 anchor 且它的值是 no — 无效果。否则，向当前行插入具有所提供 锚点名 的 HTML 锚点。
    • 如果未指定，则仅当指定了参数 num 时才插入锚点。这种情况下锚点名遵循模式“版本 num”，其中 num 等于 num 的值，比如，当 num=1 时锚点名为 版本 1。这里对 num 参数的依赖，简化了与如 {{vl}} 或 {{eq impl}} 等模板一起使用时锚点与链接之间关联的建立，它们也预期这种“版本 n”命名模式的链接。
  • noexcept (可选)
    • 指定了 noexcept 时即使用其值（如c++11）向版本区域添加“noexcept”修订版标签（此时即为 (C++11 起为 noexcept)）。
  • constexpr (可选)
    • 指定了 constexpr 时即使用其值（如c++20）向版本区域添加“constexpr”修订版标签（此时即为 (C++20 起为 constexpr)）。
  • expos (可选)
    • 指定了值 yes 时项版本区添加 (仅用于阐述*) 标注。

{{ddcl|header=标头 (可选)| 的参数 }}

一种组合情况的简便写法：{{dcl header}} + {{dcl begin}} + {{dcl ...}} + {{dcl end}}，可在仅需描述一条声明时使用。

{{ddcla|header=标头 (可选)| 的参数 }}

一种组合情况的简便写法：{{dcl header}} + {{dcl begin}} + {{dcla ...}} + {{dcl end}}，可在仅需描述一条声明时使用。

{{dcl rev multi|num=编号 (可选)|anchor=锚点名|编号 (可选)|notes=注解 (可选)|since1=起始标准1 |until1=截止标准1 |dcl1=声明1 |... }}

单模板带版本声明列表；至多支持 7 个版本。 sinceX 默认为 untilX-1 ，而 untilX 默认为 sinceX+1。
  • anchor (可选) – 与 {{dcla}} 的 anchor 参数作用相同。

示例

 
    {{dcl header | abcd.h}}
    {{dcl | notes=快于 {{c|foo_slow}} | num=1 |
    int foo( char a );
    }}
    {{dcl | since=c++11 | num=2 |
    int foo( char a, int b );
    }}
    {{dcl rev begin | num=3}}
    {{dcl | until=c++11 | 1=
    int foo( char a, char b = 'a' );
    }}
    {{dcl | since=c++11 | until=c++14 | 1=
    int foo( char a, char b = 'b' );
    }}
    {{dcl | since=c++14 | 1=
    int foo( char a, char b = 'c' );
    }}
    {{dcl rev end}}
    {{dcl rev begin}}
    {{dcl | until=c++11 | num=4 | 1=
    int foo( char a, char b = 'a' );
    }}
    {{dcl | since=c++11 | until=c++14 | num=5 | 1=
    int foo( char a, char b = 'b' );
    }}
    {{dcl | since=c++14 | num=6 | 1=
    int foo( char a, char b = 'c' );
    }}
    {{dcl rev end}}
    {{dcl rev multi | num=7 | dcl1=
    int foo( char a, char b = 'a' );
    |since2=c++11 | dcl2=
    int foo( char a, char b = 'b' );
    |since3=c++14 | dcl3=
    int foo( char a, char b = 'c' );
    |since4=c++17 | dcl4=
    int foo( char a, char b = 'd' );
    }}

上述结果如下：

在标头 <abcd.h> 定义 
int foo( char a );
(1) 快于 foo_slow 
int foo( char a, int b );
(2) (C++11 起)
(3) 
int foo( char a, char b = 'a' );
(C++11 前) 
int foo( char a, char b = 'b' );
(C++11 起)
(C++14 前) 
int foo( char a, char b = 'c' );
(C++14 起) 
int foo( char a, char b = 'a' );
(4) (C++11 前) 
int foo( char a, char b = 'b' );
(5) (C++11 起)
(C++14 前) 
int foo( char a, char b = 'c' );
(6) (C++14 起) 
int foo( char a, char b = 'a' );
(7) (C++11 前) 
int foo( char a, char b = 'b' );
(C++11 起)
(C++14 前)		 
int foo( char a, char b = 'c' );
(C++14 起)
(C++17 前)		 
int foo( char a, char b = 'd' );
(C++17 起)

示例

 
   {{ddcl | header=mutex | since=c++11 | 1=
   template< class Lockable1, class Lockable2, class... LockableN >
   void lock( Lockable1& lock1, Lockable2& lock2, LockableN&... lockn );
   }}

上述结果如下：

在标头 <mutex> 定义 
template< class Lockable1, class Lockable2, class... LockableN >
void lock( Lockable1& lock1, Lockable2& lock2, LockableN&... lockn );
(C++11 起)