Template:dsc fun

|- class="t-dsc" | |
(函数) |-

模板文档

这是一系列用于创建描述列表的模板之一。这些模板应该用来设计函数、变量或类型列表。

模板系列列表

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

{{dsc begin}}

开始描述列表

{{dsc end}}

终止描述列表

{{dsc h1| 表头}}

向描述列表添加头（h3等级）

{{dsc h2| 表头}}

向描述列表添加子头（h5等级）

{{dsc header}}

添加特性来源的头文件解释

{{dsc namespace}}

添加特性所在的命名空间解释

{{dsc sep}}

添加分隔符

{{dsc| 名称| 解释}}

添加通用项到描述列表。若忽略解释，则此项占两列。

{{dsc hitem| 名称| 解释}}

添加高亮项目到描述列表。若忽略解释，则此项占两列。

{{dsc inc| 位置| 参数1 (可选)| 参数2 (可选) ...}}

将dsc-list-template-name 变量设置成位置，包含来自位置的模板，再取消设置变量。凡是在从模板复制dsc项时就使用此模板；这会为它们添加一个编辑链接。未命名参数参数1、 参数2……会被传递给模板。

{{dsc break}}

打断列。上方的列宽度不会依赖下方内容，反之亦然。

{{dsc todo| 原因}}

添加待做的项目（同{{todo}}）。

特化模板

这些模板已经为多数使用状况而特化。

类

{{dsc class| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到类描述的项。

{{dsc tclass| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到类模板描述的项。

{{dsc talias| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到别名模板描述的项。

{{dsc ptclass| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到类模板特化描述的项。

{{dsc mem class| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到成员类描述的项。

函数

{{dsc fun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到函数描述的项。

{{dsc tfun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到函数模板描述的项。

{{dsc mem fun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到公共成员函数描述的项。

{{dsc prot mem fun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到受保护成员函数描述的项。

{{dsc mem ctor| 链接| notes=链接注解(可选)| 解释}}

添加链接到公共构建器描述的项。

{{dsc prot mem ctor| 链接| notes=链接注解(可选)| 解释}}

添加链接到受保护构建器描述的项。

{{dsc mem dtor| 链接| notes=链接注解(可选)| 解释}}

添加链接到公共析构器描述的项。

{{dsc prot mem dtor| 链接| notes=链接注解(可选)| 解释}}

添加链接到受保护析构器描述的项。

{{dsc mem vdtor| 链接| notes=链接注解(可选)| 解释}}

添加链接到虚公共析构器描述的项。

{{dsc prot mem vdtor| 链接| notes=链接注解(可选)| 解释}}

添加链接到虚受保护析构器描述的项。

{{dsc mem sfun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到静态成员函数描述的项。

{{dsc mem vfun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到虚公共成员函数模板描述的项。

{{dsc prot mem vfun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到虚受保护成员函数模板描述的项。

{{dsc macro fun| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到函数宏描述的项。

常量

{{dsc macro const| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到宏常量描述的项。

{{dsc const| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到全局常变量描述的项。

{{dsc mem const| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到常成员变量描述的项。

{{dsc mem sconst| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到静态常成员变量描述的项。

对象

{{dsc mem obj| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到成员对象描述的项。

{{dsc prot mem obj| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到受保护成员对象描述的项。

{{dsc priv mem obj| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到私有成员对象描述的项。

杂项

{{dsc typedef| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到类型定义描述的项。

{{dsc enum| 链接| title=链接标题(可选)| notes=链接注解(可选)| 解释}}

添加链接到枚举或枚举类描述的项。

{{dsc concept| 链接| title=链接标题(可选)| notes=链接注解(可选)| explanation}}

添加链接到概念描述的项。

参数

链接

此参数控制链接目标。

title=链接标题

此参数覆盖链接标题

notes=链接注解

此参数在链接后添加文字，文字不是链接的一部分

解释

该特性的解释。

所有模板都接受nolink=true参数。此情况下不生成链接，格式相同。

为成员对象而设的模板接受inlinemem=true参数。这应当在对功能性的描述内嵌于类的页面时使用。

参阅模板

用于参阅列表。

{{dsc see cpp| 位置| nomono=true_if_serif (可选)| 标题1(可选)| 标题2(可选) ...}}

添加到特性的C++文档的链接。

{{dsc see c| 位置| nomono=true_if_serif (可选)| 标题1(可选)| 标题2(可选) ...}}

添加特性到C文档的链接。

参数

位置

此参数控制链接目标。

nomono

若衬线字体应当用于标题时为true。

标题1、 标题2……

此参数覆盖标题（默认标题是从位置猜测的）。若提供了不止一项，则标题之间会以逗号分隔。

示例

 
  {{dsc begin}}
  {{dsc h1 | 魔法生物}}
  {{dsc h2 | 龙}}
  {{dsc header | dragon.h}}
  {{dsc fun | cpp/dragon/call_dragon | 召唤龙}}
  {{dsc fun | cpp/dragon/receive_fire | 获取火焰}}
  {{dsc end}}
  

上面的示例结果如下：

魔法生物
龙
定义于头文件 <dragon.h>
call_dragon	召唤龙 (函数)
receive_fire	获取火焰 (函数)

用于实现的模板

{{dsc member}}

{{dsc member| 页面| 标题 (可选)| nolink=true_if_nolink (可选)| nobold=true_if_nobold (可选)| notes=注解 (可选)}}

链接的默认标题是页面。自定义标题可以通过第二个未命名参数或title参数提供。若nolink true，则不生成链接。

链接的默认字体是粗间隔体。若nobold为true，则字体为通常衬线体。

需要置于链接右侧的附加注解可以通过notes参数传递。

title和notes参数都可以接受<br>标签，而无需打断输出。

{{dsc mark mem}}

{{dsc mark mem| 链接| mark_class| nomem=true_if_nomem (可选)| inlinemem=true_if_inlinemem (可选)}}

输出{{mark mark_class}}并于需要时后补函数/类所属类的附加性描述。

模板会特别检查链接所链接页面的亲页面是不是模板所用页面的亲页面（即它们是兄弟）。例如，考虑链接 = a/b/c而页面是使用模板的页面。若页面等于z/z/z、 a/z或a/b/z/z，则模板将会后续附加性描述，但页面是a/b/z或a/b时不会。

若nomem为true，则附加性描述决不出现。

模板从a/b/标题页面取得关于亲类名称的信息。

若inlinemem为true，则亲类名称会从a/b/c/标题模板取得。这用于类描述内嵌地包含其成员描述时。

{{dsc editlink}}

{{dsc editlink}}

输出带有指向编辑模板的页面链接的[edit]文本，模板名称定义于dsc-list-template-name变量。至少要给此模板传递一个空设的参数，因为Mediawiki软件使用了一些破坏实现的优化。