本网站正在建设中(~ ̄▽ ̄)~

  • 你好~!欢迎来到中文歌声合成个人收集站-VCPedia.cn!
  • 若发现页面信息有误投稿至本站,请联系管理员。

Template:Example/doc

VCPedia.cn ——关于中文歌声合成的一切。
跳到导航 跳到搜索

该模板用于显示代码示例,避免在同时显示代码和代码效果时,需要再复制一份代码的问题。

在此基础上,该模板能够使用wikitext以及模板(如{{color}})对展示的代码进行格式标注。

基本用法:

{{Example|pre=<nowiki>向Example模板传入示例代码('''要有nowiki'''),将呈现出一个{{荧光笔|代码块}},并且展示代码块的结果。</nowiki>}}

它的执行结果为两段,包含一段代码和一段该代码的结果: Lua错误:bad argument #1 to 'unstripNoWiki' (string expected, got nil)。

代码展示模式

代码展示模式决定了你的代码在展示时使用什么标签包裹。

模板调用 说明
{{Example|pre=<nowiki>代码</nowiki>}} 展示代码时,将代码用<pre></pre>包裹
{{Example|code=<nowiki>代码</nowiki>}} 展示代码时,将代码用<code></code>包裹
{{Example|bare=<nowiki>代码</nowiki>}} 展示代码时,不包裹代码

pre

在编辑框输入:

{{example|pre=<nowiki>{{color|green|hello}}</nowiki>}}

显示为: Lua错误:bad argument #1 to 'unstripNoWiki' (string expected, got nil)。

code

在编辑框输入:

{{example|code=<nowiki>{{color|green|hello}}</nowiki>}}

显示为:Lua错误:bad argument #1 to 'unstripNoWiki' (string expected, got nil)。

bare

在编辑框输入:

{{Example|bare=<nowiki>{{color|green|hello}}</nowiki>}}

显示为:Lua错误:bad argument #1 to 'unstripNoWiki' (string expected, got nil)。

衔接语

如果觉得太生硬,可以添加衔接语。

模板调用 说明
{{Example|pre/code/bare=<nowiki>代码</nowiki>|衔接语}} 显示为“代码 衔接语 结果”

例如,在编辑框输入:

{{Example|code=<nowiki>{{color|green|hello}}</nowiki>|的解析结果是}}

显示为:

的解析结果是

代码批注

pre/code/bare参数中,可以指定只在代码展示中出现,而不在结果展示中出现的批注。例如,可以给代码中想要强调的部分用wikitext及模板加粗、加注释、加上颜色等。为此,只需把批注放在<nowiki></nowiki>之外即可。

总之,你只要记住“只有<nowiki></nowiki>内部的代码才是我要执行的代码”。

例如,在编辑框输入:

{{example
|pre=这句话只会出现在代码展示中。
<nowiki
  >{{color|</nowiki>{{color|green|<nowiki
  >green</nowiki>}}<ref>这是一个在代码块中的注释。同时请注意前面绿色的“green”。</ref><nowiki
  >|hello}}</nowiki>
如果太长,可以在nowiki与>之间换行以提升可读性,这不会导致多出空白字符。
}}

显示为: Lua错误:bad argument #1 to 'unstripNoWiki' (string expected, got nil)。

nowiki嵌套

你的模板可能接收含有<nowiki></nowiki>的内容,而你想展示它的用法。但是,Example也需要接收含有<nowiki></nowiki>的参数,可<nowiki></nowiki>内部是不能再嵌套<nowiki></nowiki>的!

这时,只需把内层的<nowiki></nowiki>改为<_nowiki></_nowiki>即可,它在展示的时候会被当作不带下划线的。你可以在<_nowiki></_nowiki>里继续嵌套,每次增加一个下划线。

比如下面这个例子:

Lua错误:bad argument #1 to 'unstripNoWiki' (string expected, got nil)。

显示为:

结果:

不显示结果

模板调用 说明
{{Example|pre/code/bare=<nowiki>代码</nowiki>|echo=}} 显示为“代码”,没有衔接语和结果

注释