模板:Example

模板文檔  

這個文檔嵌入自Template:Example/doc。

該模板用於顯示代碼示例，避免在同時顯示代碼和代碼效果時，需要再複製一份代碼的問題。

在此基礎上，該模板能夠使用wikitext以及模板（如{{color}}）對展示的代碼進行格式標註。

基本用法：

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

它的執行結果為兩段，包含一段代碼和一段該代碼的結果：

向Example模板传入示例代码（'''要有nowiki'''），将呈现出一个{{荧光笔|代码块}}，并且展示代码块的结果。

向Example模板傳入示例代碼（要有nowiki），將呈現出一個代碼塊，並且展示代碼塊的結果。

代碼展示模式

代碼展示模式決定了你的代碼在展示時使用什麼標籤包裹。

模板調用	說明
{{Example|pre=<nowiki>代码</nowiki>}}	展示代碼時，將代碼用<pre></pre>包裹
{{Example|code=<nowiki>代码</nowiki>}}	展示代碼時，將代碼用<code></code>包裹
{{Example|bare=<nowiki>代码</nowiki>}}	展示代碼時，不包裹代碼

pre

在編輯框輸入：

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

顯示為：

{{color|green|hello}}

hello

code

在編輯框輸入：

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

顯示為：{{color|green|hello}}hello

bare

在編輯框輸入：

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

顯示為：{{color|green|hello}}hello

銜接語

如果覺得太生硬，可以添加銜接語。

模板調用	說明
{{Example|pre/code/bare=<nowiki>代码</nowiki>|銜接語}}	顯示為「代碼 銜接語 結果」

例如，在編輯框輸入：

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

顯示為：{{color|green|hello}}的解析結果是hello

代碼批註

在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与>之间换行以提升可读性，这不会导致多出空白字符。
}}

顯示為：

这句话只会出现在代码展示中。
{{color|green|hello}}
如果太长，可以在nowiki与>之间换行以提升可读性，这不会导致多出空白字符。

hello

nowiki嵌套

你的模板可能接收含有<nowiki></nowiki>的內容，而你想展示它的用法。但是，Example也需要接收含有<nowiki></nowiki>的參數，可<nowiki></nowiki>內部是不能再嵌套<nowiki></nowiki>的！

這時，只需把內層的<nowiki></nowiki>改為<_nowiki></_nowiki>即可，它在展示的時候會被當作不帶下劃線的。你可以在<_nowiki></_nowiki>里繼續嵌套，每次增加一個下劃線。

比如下面這個例子：

{{Example
|pre=<nowiki>{{ptl|define=plus1
|tl=<_nowiki>{{#expr:{{{1 | 0}}} + 1}}</_nowiki>
}}
{{ptl}}，{{ptl|10}}</nowiki>
|1=结果：
}}

顯示為：

{{ptl|define=plus1
|tl=<nowiki>{{#expr:{{{1 | 0}}} + 1}}</nowiki>
}}
{{ptl}}，{{ptl|10}}

結果： 1，11

不顯示結果

模板調用	說明
{{Example|pre/code/bare=<nowiki>代码</nowiki>|echo=}}	顯示為「代碼」，沒有銜接語和結果

注釋