模板:Code/doc

来自决策链云智库


Usage

Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use pre>>...</pre> or syntaxhighlight>>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.

The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:

some '''wiki''' text

However, {{code|a {{template}} call}} will still invoke the template:

a &#123;&#123;[[Template:{{{1}}}|{{{1}}}]]&#125;&#125; call

Use nowiki>>...</nowiki> around the template name to avoid this problem:

a {{template}} call

When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

foo &nbsp;{{code|bar baz}}&nbsp; quux.

is well spaced:

foo  bar baz  quux.

versus:

foo {{code|bar baz}} quux.

which is less visually clear:

foo bar baz quux.

because "foo" and "bar" will seem more closely associated than "bar" and "baz"; the width of the space character in a monospaced font is almost always larger than in a proportional font.

Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though html4strict and html5 are valid values, as are php, perl, css, javascript, mysql and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.

This template does not need to be substituted.

Examples

Markup Renders as
Lorem {{code|ipsum '''dolor'''}} sit amet

Lorem ipsum '''dolor''' sit amet

The declaration {{code |lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.

The declaration int foo(const std::string& bar, const std::vector<long double*>& baz); is the prototype for a function defined later.

If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also [[:bugzilla:5138]].

If the code contains an equals sign, such as var img = document.getElementsByTagName("img");, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also bugzilla:5138.

Included templates

Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use code>>...</code> as a wrapper instead of this template.

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Markup Renders as
{{code|
{{cite web |title=Title |url=http://example.org}}
}}

'"`UNIQ--templatestyles-00000027-QINU`"'<cite class="citation web cs1">[http://example.org "Title"].</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Title&rft_id=http%3A%2F%2Fexample.org&rfr_id=info%3Asid%2Fwiki.statsape.com%3A%E6%A8%A1%E6%9D%BF%3ACode%2Fdoc" class="Z3988"></span>

The above example shows the HTML rendered by the citation template, including the hidden metadata.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Code in articles based on its TemplateData.

TemplateData for Code

An inline source code string.
Code1
code
The code to display.
Language2
lang
The programming language of the source code. List of valid values is at: mw:Extension:SyntaxHighlight
默认值
text
Classclass
IDid
CSS Stylestyle

See also