cc – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add partial multiline support)
(Remove codecomment dependency, Add Category:cc template usage error categorisation)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly>{{#ifeq:{{{1}}}
<includeonly><span class="code-comment">//&nbsp;{{Trim|{{{1|-no comment defined-{{TemplateCase||[[Category:cc template usage error]]}}}}}}}</span></includeonly><noinclude>{{Doc/Template
|{{#replace:{{{1}}}|<nowiki/>
|descr= Displays a one-lined code comment. See {{Template|codecomment}} for multi-lines comments. It also adds the page to the [[:Category:cc template usage error|cc template usage error]] category on usage error.
<nowiki/>|}}
|<span style="color: #00F; font-style: italic"><nowiki>//</nowiki>&nbsp;{{Trim|{{{1|-no comment defined-}}}}}</span>
|<span style="color: #00F; font-style: italic">/*
{{#ifeq:
{{#replace:{{{1}}}|<nowiki>
</nowiki>|}}|
{{#replace:{{{1}}}|<nowiki/>
<nowiki/> <nowiki/>|}}
|{{Trim|{{{1|-no comment defined-}}}}}
<nowiki/>*/
|<nowiki/>
{{{1|-no comment defined-}}}
<nowiki/>*/}}</span>
}}</includeonly><noinclude>__NOTOC__
Displays a code comment.
{| style="float: right; min-width: 50em; max-width: 50%"
| colspan="4" |
{{Important|This template has an issue with multiline comments in code blocks formatted with space-starting lines (see below). Use <tt>&lt;code&gt;</tt> tags instead for multiline comments.}}
|-
| style="vertical-align: top" |
spaced
{{cc|test1
test2
test3}}
| style="vertical-align: top" |
spaced + line return
{{cc|
test1
test2
test3}}
| style="vertical-align: top" |
code tag
<code>{{cc|test1
test2
test3}}</code>
| style="vertical-align: top" |
code tag + line return
<code>{{cc|
test1
test2
test3}}</code>
|}
== Usage ==
{{<nowiki/>cc|'''''message'''''}}
* message: comment to display


{| class="wikitable"
|param1= message
|+ Examples
|descr1= comment to display
! Code
 
! Result
|example1= <nowiki>{{cc}}</nowiki>
|-
|result1= {{cc}}
| <nowiki>{{cc}}</nowiki>
 
| {{cc}}
|example2= <nowiki>{{cc|this code is wonderful}}</nowiki>
|-
|result2= {{cc|this code is wonderful}}
| <nowiki>{{cc|this code is wonderful}}</nowiki>
 
| {{cc|this code is wonderful}}
|example3= <div style="white-space: pre"><nowiki>{{cc|this
|-
| <nowiki>{{cc|this
code
code
is
is
wonderful}}</nowiki>
wonderful}}</nowiki></div>
|
|result3= {{cc|this
{{cc|this
code
code
is
is
wonderful}}
wonderful}}
|-
}}</noinclude>
|
<pre><code>{{cc|this
code
is
wonderful}}</code></pre>
| <span style="color: #00F; font-style: italic; white-space: pre">/*
this
code
is
wonderful
<nowiki/>*/</span>
|-
|
<pre><code>{{cc|
this
code
is
wonderful}}</code></pre>
| <span style="color: #00F; font-style: italic; white-space: pre">/*
this
code
is
wonderful
<nowiki/>*/</span>
|}
 
== Source ==
<syntaxhighlight lang="html">
<span style="color: #00F; font-style: italic"><nowiki>//</nowiki>&nbsp;{{Trim|{{{1|-no comment defined-}}}}}</span>
</syntaxhighlight>
 
== See also ==
* [[Template:codecomment]]
 
 
[[Category:Templates|{{uc:cc}}]]
</noinclude>

Latest revision as of 14:56, 30 June 2022

Displays a one-lined code comment. See {{codecomment}} for multi-lines comments. It also adds the page to the cc template usage error category on usage error.

This template is used on these pages.

Usage

{{cc|message}}

  • message: comment to display
Examples
Code Result
{{cc}} // -no comment defined-
{{cc|this code is wonderful}} // this code is wonderful
{{cc|this code is wonderful}}
 // this

code is wonderful

Retrieved from "https://community.bistudio.com/wiki?title=Template:cc&oldid=323125"