模板:注/doc
< 模板:注
本模板用于插入注释,相当于直接输入 <ref group="注">注释内容</ref>
,更加简洁和方便。
本模板需要与 {{notelist}}
模板配合使用,在专门注释章节中容纳注释列表。不要把用于注释的 {{注}}
{{notelist}}
模板与用于参考资料的 {{参}}
{{reflist}}
混用。
注释的具体使用规范详见 Project:编写规范#注释。
参数
参数1
:注释的内容group
:注释的分组,留空则使用默认分组注
name
:注释的名字,可选
使用方法
在需要插入注释的地方使用 {{注|注释内容}}
。大部分情况下只需填写注释内容,其他参数留空即可。
可以根据需要填写 group
参数创建其他的分组,但此时需要注意注释列表的使用。
可以使用 name
参数给需要重复使用的注释命名。这样,之后再使用时就不必再重复注释内容,可以将 参数1
留空,只需指定名字和分组就可以调用。
注意重复使用注释时,需要同时指定名字和分组。如果该注释的 group
参数留空使用默认分组 注
,那么重复使用时也可以留空,只写 name
即可;如果该注释属于其他分组,重复使用时就需要同时写明 name
与 group
,否则会报错。
示例
基础使用
加在需要的地方{{注|第一条注释。}}。
加在需要的地方[注 1]。
使用不同分组
创建不同分组之后要注意注释列表{{注|第二条注释的分组不同。|group=新}}。
创建不同分组之后要注意注释列表[新 1]。
使用命名
需要重复使用的注释可以命名{{注|第三条注释有名字,可以重复调用。|name=重复}}。
需要重复使用的注释可以命名[注 2]。
然后就可以快速调用了:{{注|name=重复}}。
然后就可以快速调用了:[注 2]。
注意事项
不使用默认分组的注释,重复使用时不要忘记分组{{注|第四条注释的分组不同,重复调用时要记得指定分组。|group=特殊|name=注意}}。
不使用默认分组的注释,重复使用时不要忘记分组[特殊 1]。
再调用时:{{注|group=特殊|name=注意}}。
再调用时:[特殊 1]。
创建全部分组的注释列表
{{notelist}} {{notelist|group=新}} {{notelist|group=特殊}}
- ↑ 第二条注释的分组不同。